Skip to main content
Version: v3

PaginationFilterField

Filter the pagination result by these specific fields

In format of <field><equality><value>

For example

  • metadata.name=test
  • metadata.namespace!=system

These are sub items for PaginationParam, for example filter=<PaginationFilterField>

For more information regarding the API see https://github.com/rancher/steve?tab=readme-ov-file#query-parameters

Constructors​

Constructor​

new PaginationFilterField(args): PaginationFilterField;

Parameters​

args​

FilterFieldCtorArgs

Returns​

PaginationFilterField

Properties​

equality?​

optional equality?: PaginationFilterEquality;

Equality symbol used to compare the field with the value

equals?​

optional equals?: boolean;

Equality field within the object to filter by for example the = or != of x=y

Deprecated​

Please use equality instead of equals and exact

exact?​

optional exact?: boolean;

Match the field exactly. False for partial matches

Value: pod1 Exact: true. "p" no, "pod", no, "pod1" yes Exact: false. "p" yes, "pod", yes, "pod1" yes

Deprecated​

Please use equality instead of equals and exact

exists?​

optional exists?: boolean;

Check if the field/property exists, regardless of value

If this is false it does not flip the expectation, just doesn't add the field

field?​

optional field?: string;

Name of field within the object to filter by for example the x of x=y

This can be optional for some (projectsornamespaces)

value?​

optional value?: string;

Value of field within the object to filter by for example the y of x=y

This can be empty if exists is true

Methods​

safeEquality()​

static safeEquality(args): PaginationFilterEquality;

Determine equality for this field.

Mainly to ensure legacy objects using deprecated fields instead of new equality field fall back on something sensible

Parameters​

args​

FilterFieldCtorArgs | PaginationFilterField

Returns​

PaginationFilterEquality