Skip to main content
Version: v3

FindFilteredPageOptions

Options for findFiltered when using server-side pagination (pagination mode).

Requires pagination settings for server-side filtering, sorting, and pagination via the Steve API's pagination cache. Only available when ui-sql-cache is enabled.

Example​

import { useResources, K8S } from '@shell/apis';

const resources = useResources();

const pods = await resources.cluster.findFiltered(K8S.POD, {
  pagination: {
    page: 1,
    pageSize: 10,
    projectsOrNamespaces: [],
    filters: [],
    sort: []
  }
});

See ActionFindPageArgs for complete pagination options.

Extends​

  • ActionFindPageArgs

Properties​

force?​

optional force?: boolean;

Force the request to go to the server instead of checking for a cached value first

Inherited from​

ActionFindPageArgs.force

includeAssociatedData?​

optional includeAssociatedData?: boolean;

When making a supporting HTTP request include associated resource data

Inherited from​

ActionFindPageArgs.includeAssociatedData

namespaced?​

optional namespaced?: string;

The single namespace to filter by (used in url path, not part of pagination params)

Inherited from​

ActionFindPageArgs.namespaced

pagination​

pagination: PaginationArgs;

Set of pagination settings that creates the url.

This is stored and can be used to compare in new request to determine if we already have this page

Inherited from​

ActionFindPageArgs.pagination

revision?​

optional revision?: string;

The target minimum revision for the resource.

If this is higher than the latest revision known to rancher then an error will be returned

Inherited from​

ActionFindPageArgs.revision

transient?​

optional transient?: boolean;

If true don't persist the http response to the store, just pass it back

Inherited from​

ActionFindPageArgs.transient

url?​

optional url?: string;

Use this to override URL instead of looking up the URL for the type/id

Inherited from​

ActionFindPageArgs.url

watch?​

optional watch?: boolean;

Watch for changes

false = no, all other values = yes

Inherited from​

ActionFindPageArgs.watch