Skip to main content
Version: v3

PaginationParamProjectOrNamespace

This is a convenience class for the projectsornamespaces param which works some magic, adds defaults and converts to the required PaginationParam format

See description for PaginationParam for how multiple of these can be combined together to AND or OR together

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

Extends​

  • PaginationParam

Constructors​

Constructor​

new PaginationParamProjectOrNamespace(__namedParameters): PaginationParamProjectOrNamespace;

Parameters​

__namedParameters​
equals?​

boolean = true

should param equal fields For definition see PaginationParam equals

projectOrNamespace?​

string[] = []

Collection of projects / namespace id's to filter by

These are OR'd together

For clarification on definition see PaginationFilterField

Returns​

PaginationParamProjectOrNamespace

Overrides​

PaginationParam.constructor

Properties​

equals​

equals: boolean;

should fields equal param.

For example projectsornamexspaces=x or projectsornamexspaces!=x

Inherited from​

PaginationParam.equals

fields​

fields: PaginationFilterField[];

Fields to filter by

For example metadata.namespace=abc OR metadata.namespace=xyz

Inherited from​

PaginationParam.fields

param​

param: string;

Query Param. For example filter or projectsornamespaces

Inherited from​

PaginationParam.param