Class: BackendTrafficPolicy

Defined in: lib/k8s/backendTrafficPolicy.ts:98

XBackendTrafficPolicy – Gateway API experimental resource that controls client behaviour (retries, session stickiness, etc.) when talking to a backend.

See

https://gateway-api.sigs.k8s.io/reference/api-spec/main/specx/#xbackendtrafficpolicy

Extends

KubeObject<KubeBackendTrafficPolicy>

Constructors

Constructor

new BackendTrafficPolicy(json: KubeBackendTrafficPolicy, cluster?: string): BackendTrafficPolicy;

Defined in: lib/k8s/KubeObject.ts:109

Parameters

Parameter	Type
`json`	`KubeBackendTrafficPolicy`
`cluster?`	`string`

Returns

BackendTrafficPolicy

Inherited from

KubeObject.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
`_clusterName`	`public`	`string`	`undefined`	-	-	`KubeObject`.`_clusterName`	lib/k8s/KubeObject.ts:59
`jsonData`	`public`	`KubeBackendTrafficPolicy`	`undefined`	-	-	`KubeObject`.`jsonData`	lib/k8s/KubeObject.ts:56
`_internalApiEndpoint?`	`static`	\| `ApiClient`<`KubeObjectInterface`> \| `ApiWithNamespaceClient`<`KubeObjectInterface`>	`undefined`	-	-	`KubeObject`.`_internalApiEndpoint`	lib/k8s/KubeObject.ts:76
`apiName`	`static`	`string`	`'xbackendtrafficpolicies'`	Name of the resource, plural, used in API	`KubeObject`.`apiName`	-	lib/k8s/backendTrafficPolicy.ts:100
`apiVersion`	`static`	`string`[]	`undefined`	Group and version of the resource formatted as "GROUP/VERSION", e.g. "policy.k8s.io/v1".	`KubeObject`.`apiVersion`	-	lib/k8s/backendTrafficPolicy.ts:101
`isNamespaced`	`static`	`boolean`	`true`	Whether the object is namespaced.	`KubeObject`.`isNamespaced`	-	lib/k8s/backendTrafficPolicy.ts:102
`isScalable`	`readonly`	`boolean`	`undefined`	Whether the object is scalable, and should have a ScaleButton	-	`KubeObject`.`isScalable`	lib/k8s/KubeObject.ts:74
`kind`	`static`	`string`	`'XBackendTrafficPolicy'`	The kind of the object. Corresponding to the resource kind in Kubernetes.	`KubeObject`.`kind`	-	lib/k8s/backendTrafficPolicy.ts:99
`readOnlyFields`	`static`	`string`[]	`[]`	Readonly field defined as JSONPath paths	-	`KubeObject`.`readOnlyFields`	lib/k8s/KubeObject.ts:58

Accessors

cluster

Get Signature

get cluster(): string;

Defined in: lib/k8s/KubeObject.ts:114

Returns

string

Set Signature

set cluster(cluster: string): void;

Defined in: lib/k8s/KubeObject.ts:118

Parameters

Parameter	Type
`cluster`	`string`

Returns

void

Inherited from

KubeObject.cluster

detailsRoute

Get Signature

get detailsRoute(): string;

Defined in: lib/k8s/KubeObject.ts:126

Returns

string

Inherited from

KubeObject.detailsRoute

isNamespaced

Get Signature

get isNamespaced(): boolean;

Defined in: lib/k8s/KubeObject.ts:235

Returns

boolean

Inherited from

KubeObject.isNamespaced

isScalable

Get Signature

get isScalable(): boolean;

Defined in: lib/k8s/KubeObject.ts:239

Returns

boolean

Inherited from

KubeObject.isScalable

kind

Get Signature

get kind(): any;

Defined in: lib/k8s/KubeObject.ts:189

Returns

any

Inherited from

KubeObject.kind

listRoute

Get Signature

get listRoute(): string;

Defined in: lib/k8s/KubeObject.ts:181

Returns

string

Inherited from

KubeObject.listRoute

metadata

Get Signature

get metadata(): KubeMetadata;

Defined in: lib/k8s/KubeObject.ts:231

Returns

KubeMetadata

Inherited from

KubeObject.metadata

pluralName

Get Signature

get pluralName(): string;

Defined in: lib/k8s/KubeObject.ts:176

Returns

string

Inherited from

KubeObject.pluralName

retryConstraint

Get Signature

get retryConstraint(): RetryConstraint | undefined;

Defined in: lib/k8s/backendTrafficPolicy.ts:112

Returns

RetryConstraint | undefined

sessionPersistence

Get Signature

get sessionPersistence(): SessionPersistence | undefined;

Defined in: lib/k8s/backendTrafficPolicy.ts:116

Returns

SessionPersistence | undefined

spec

Get Signature

get spec(): BackendTrafficPolicySpec;

Defined in: lib/k8s/backendTrafficPolicy.ts:104

Returns

BackendTrafficPolicySpec

targetRefs

Get Signature

get targetRefs(): BackendTrafficPolicyTargetRef[];

Defined in: lib/k8s/backendTrafficPolicy.ts:108

Returns

BackendTrafficPolicyTargetRef[]

apiEndpoint

Get Signature

get static apiEndpoint(): 
  | ApiClient<KubeObjectInterface>
| ApiWithNamespaceClient<KubeObjectInterface>;

Defined in: lib/k8s/KubeObject.ts:78

Returns

| ApiClient<KubeObjectInterface> | ApiWithNamespaceClient<KubeObjectInterface>

Set Signature

set static apiEndpoint(endpoint: 
  | ApiClient<KubeObjectInterface>
  | ApiWithNamespaceClient<KubeObjectInterface>): void;

Defined in: lib/k8s/KubeObject.ts:105

Parameters

Parameter	Type
`endpoint`	\| `ApiClient`<`KubeObjectInterface`> \| `ApiWithNamespaceClient`<`KubeObjectInterface`>

Returns

void

Inherited from

KubeObject.apiEndpoint

apiGroupName

Get Signature

get static apiGroupName(): string | undefined;

Defined in: lib/k8s/KubeObject.ts:142

Get name of the API group of this resource for example will return batch for CronJob

For core group, like Pods, it will return undefined

API group reference https://kubernetes.io/docs/reference/using-api/#api-groups

Returns

string | undefined

Inherited from

KubeObject.apiGroupName

className

Get Signature

get static className(): string;

Defined in: lib/k8s/KubeObject.ts:122

Returns

string

Inherited from

KubeObject.className

detailsRoute

Get Signature

get static detailsRoute(): string;

Defined in: lib/k8s/KubeObject.ts:130

Returns

string

Inherited from

KubeObject.detailsRoute

listRoute

Get Signature

get static listRoute(): string;

Defined in: lib/k8s/KubeObject.ts:185

Returns

string

Inherited from

KubeObject.listRoute

pluralName

Get Signature

get static pluralName(): string;

Defined in: lib/k8s/backendTrafficPolicy.ts:120

Returns

string

Overrides

KubeObject.pluralName

Methods

_class()

_class(): typeof KubeObject;

Defined in: lib/k8s/KubeObject.ts:539

Returns

typeof KubeObject

Inherited from

KubeObject._class

delete()

delete(force?: boolean): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:543

Parameters

Parameter	Type
`force?`	`boolean`

Returns

Promise<any>

Inherited from

KubeObject.delete

getAge()

getAge(): string;

Defined in: lib/k8s/KubeObject.ts:223

Returns

string

Inherited from

KubeObject.getAge

getAuthorization()

getAuthorization(
   verb: string, 
   reqResourseAttrs?: AuthRequestResourceAttrs, 
cluster?: string): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:739

Parameters

Parameter	Type
`verb`	`string`
`reqResourseAttrs?`	`AuthRequestResourceAttrs`
`cluster?`	`string`

Returns

Promise<any>

Inherited from

KubeObject.getAuthorization

getCreationTs()

getCreationTs(): string;

Defined in: lib/k8s/KubeObject.ts:219

Returns

string

Inherited from

KubeObject.getCreationTs

getDetailsLink()

getDetailsLink(): string;

Defined in: lib/k8s/KubeObject.ts:193

Returns

string

Inherited from

KubeObject.getDetailsLink

getEditableObject()

getEditableObject(): object;

Defined in: lib/k8s/KubeObject.ts:243

Returns

object

Inherited from

KubeObject.getEditableObject

getListLink()

getListLink(): string;

Defined in: lib/k8s/KubeObject.ts:207

Returns

string

Inherited from

KubeObject.getListLink

getName()

getName(): string;

Defined in: lib/k8s/KubeObject.ts:211

Returns

string

Inherited from

KubeObject.getName

getNamespace()

getNamespace(): string | undefined;

Defined in: lib/k8s/KubeObject.ts:215

Returns

string | undefined

Inherited from

KubeObject.getNamespace

getValue()

getValue(prop: string): any;

Defined in: lib/k8s/KubeObject.ts:227

Parameters

Parameter	Type
`prop`	`string`

Returns

any

Inherited from

KubeObject.getValue

patch()

patch(body: RecursivePartial<T>): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:647

Parameters

Parameter	Type
`body`	`RecursivePartial`<`T`>

Returns

Promise<any>

Inherited from

KubeObject.patch

patchUpdate()

patchUpdate(original: KubeObjectInterface, modified: KubeObjectInterface): Promise<KubeObjectInterface>;

Defined in: lib/k8s/KubeObject.ts:571

Updates a resource using JSON Patch (RFC 6902), sending only the diff between the original and modified objects. This avoids 409 Conflict errors on resources that are frequently updated by controllers (e.g. HPA).

Parameters

Parameter	Type
`original`	`KubeObjectInterface`
`modified`	`KubeObjectInterface`

Returns

Promise<KubeObjectInterface>

Inherited from

KubeObject.patchUpdate

scale()

scale(numReplicas: number): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:618

Parameters

Parameter	Type
`numReplicas`	`number`

Returns

Promise<any>

Inherited from

KubeObject.scale

update()

update(data: KubeObjectInterface): Promise<KubeObjectInterface>;

Defined in: lib/k8s/KubeObject.ts:562

Parameters

Parameter	Type
`data`	`KubeObjectInterface`

Returns

Promise<KubeObjectInterface>

Inherited from

KubeObject.update

apiGet()

static apiGet<K>(
   this: (...args: any) => K & typeof KubeObject, 
   onGet: (...args: any) => void, 
   name: string, 
   namespace?: string, 
   onError?: (err: ApiError | null, cluster?: string) => void, 
   opts?: object): (...args: any[]) => Promise;

Defined in: lib/k8s/KubeObject.ts:496

Type Parameters

Type Parameter
`K` extends `KubeObject`<`any`>

Parameters

Parameter	Type
`this`	(...`args`: `any`) => `K` & typeof `KubeObject`
`onGet`	(...`args`: `any`) => `void`
`name`	`string`
`namespace?`	`string`
`onError?`	(`err`: `ApiError` \| `null`, `cluster?`: `string`) => `void`
`opts?`	{ `cluster?`: `string`; `queryParams?`: `QueryParameters`; }
`opts.cluster?`	`string`
`opts.queryParams?`	`QueryParameters`

Returns

(...args: any[]) => Promise

Inherited from

KubeObject.apiGet

apiList()

static apiList<K>(
   this: (...args: any) => K & typeof KubeObject, 
   onList: (arg: K[]) => void, 
   onError?: (err: ApiError, cluster?: string) => void, 
opts?: ApiListSingleNamespaceOptions): () => Promise<CancelFunction>;

Defined in: lib/k8s/KubeObject.ts:273

Builds a list request for this object's API endpoint.

Type Parameters

Type Parameter
`K` extends `KubeObject`<`any`>

Parameters

Parameter	Type	Description
`this`	(...`args`: `any`) => `K` & typeof `KubeObject`	-
`onList`	(`arg`: `K`[]) => `void`	Callback function to be called when the list is retrieved.
`onError?`	(`err`: `ApiError`, `cluster?`: `string`) => `void`	Callback function to be called when an error occurs.
`opts?`	`ApiListSingleNamespaceOptions`	Options to be passed to the API endpoint.

Returns

A parameterless function that starts the list request and resolves to a CancelFunction for stopping it.

() => Promise<CancelFunction>

Inherited from

KubeObject.apiList

create()

static create<Args, T>(this: (...args: Args) => T, ...item: Args): T;

Defined in: lib/k8s/KubeObject.ts:489

Type Parameters

Type Parameter
`Args` extends `any`[]
`T` extends `KubeObject`<`any`>

Parameters

Parameter	Type
`this`	(...`args`: `Args`) => `T`
...`item`	`Args`

Returns

T

Inherited from

KubeObject.create

fetchAuthorization()

static fetchAuthorization(reqResourseAttrs?: AuthRequestResourceAttrs, cluster?: string): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:664

Performs a request to check if the user has the given permission.

Parameters

Parameter	Type
`reqResourseAttrs?`	`AuthRequestResourceAttrs`
`cluster?`	`string`

Returns

Promise<any>

The result of the access request.

Inherited from

KubeObject.fetchAuthorization

getAuthorization()

static getAuthorization(
   verb: string, 
   reqResourseAttrs?: AuthRequestResourceAttrs, 
cluster?: string): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:692

Parameters

Parameter	Type
`verb`	`string`
`reqResourseAttrs?`	`AuthRequestResourceAttrs`
`cluster?`	`string`

Returns

Promise<any>

Inherited from

KubeObject.getAuthorization

getBaseObject()

static getBaseObject(): Omit<KubeObjectInterface, "metadata"> & object;

Defined in: lib/k8s/KubeObject.ts:787

Returns

Omit<KubeObjectInterface, "metadata"> & object

Inherited from

KubeObject.getBaseObject

getErrorMessage()

static getErrorMessage(err: ApiError | null): "Error" | "Error: Not found" | "Error: No permissions" | null;

Defined in: lib/k8s/KubeObject.ts:772

Parameters

Parameter	Type
`err`	`ApiError` \| `null`

Returns

"Error" | "Error: Not found" | "Error: No permissions" | null

Inherited from

KubeObject.getErrorMessage

isClassOf()

static isClassOf<K>(this: K, maybeInstance: KubeObject): maybeInstance is InstanceType<K>;

Defined in: lib/k8s/KubeObject.ts:161

Type guard to check if a KubeObject instance belongs to this class. Compares API group name and kind to determine if the instance matches. This works even if class definitions are duplicated and should be used instead of instanceof.

Type Parameters

Type Parameter
`K` extends typeof `KubeObject`

Parameters

Parameter	Type	Description
`this`	`K`	-
`maybeInstance`	`KubeObject`	The KubeObject instance to check.

Returns

maybeInstance is InstanceType<K>

True if the instance is of this class type, with narrowed type.

Inherited from

KubeObject.isClassOf

put()

static put(data: KubeObjectInterface): Promise<KubeObjectInterface>;

Defined in: lib/k8s/KubeObject.ts:614

Parameters

Parameter	Type
`data`	`KubeObjectInterface`

Returns

Promise<KubeObjectInterface>

Inherited from

KubeObject.put

useApiGet()

static useApiGet<K>(
   this: (...args: any) => K & typeof KubeObject, 
   onGet: (item: K | null) => any, 
   name: string, 
   namespace?: string, 
   onError?: (err: ApiError | null, cluster?: string) => void, 
   opts?: object): void;

Defined in: lib/k8s/KubeObject.ts:521

Type Parameters

Type Parameter
`K` extends `KubeObject`<`any`>

Parameters

Parameter	Type
`this`	(...`args`: `any`) => `K` & typeof `KubeObject`
`onGet`	(`item`: `K` \| `null`) => `any`
`name`	`string`
`namespace?`	`string`
`onError?`	(`err`: `ApiError` \| `null`, `cluster?`: `string`) => `void`
`opts?`	{ `cluster?`: `string`; `queryParams?`: `QueryParameters`; }
`opts.cluster?`	`string`
`opts.queryParams?`	`QueryParameters`

Returns

void

Inherited from

KubeObject.useApiGet

useApiList()

static useApiList<K>(
   this: (...args: any) => K & typeof KubeObject, 
   onList: (...arg: any[]) => any, 
   onError?: (err: ApiError, cluster?: string) => void, 
   opts?: ApiListOptions): void;

Defined in: lib/k8s/KubeObject.ts:308

Type Parameters

Type Parameter
`K` extends `KubeObject`<`any`>

Parameters

Parameter	Type
`this`	(...`args`: `any`) => `K` & typeof `KubeObject`
`onList`	(...`arg`: `any`[]) => `any`
`onError?`	(`err`: `ApiError`, `cluster?`: `string`) => `void`
`opts?`	`ApiListOptions`

Returns

void

Inherited from

KubeObject.useApiList

useGet()

static useGet<K>(
   this: (...args: any) => K, 
   name: string, 
   namespace?: string, 
opts?: object): [K | null, ApiError | null] & QueryResponse<K, ApiError>;

Defined in: lib/k8s/KubeObject.ts:463

Type Parameters

Type Parameter
`K` extends `KubeObject`<`any`>

Parameters

Parameter	Type	Description
`this`	(...`args`: `any`) => `K`	-
`name`	`string`	-
`namespace?`	`string`	-
`opts?`	{ `cluster?`: `string`; `initialData?`: `K`; `queryParams?`: `QueryParameters`; }	-
`opts.cluster?`	`string`	-
`opts.initialData?`	`K`	Seed data to use before the query resolves. Must be reference-stable across renders (memoize it or capture it once) — an object rebuilt on every render will cause repeated re-renders.
`opts.queryParams?`	`QueryParameters`	-

Returns

[K | null, ApiError | null] & QueryResponse<K, ApiError>

Inherited from

KubeObject.useGet

useList()

static useList<K>(this: (...args: any) => K & typeof KubeObject, __namedParameters?: object & QueryParameters): [K[] | null, ApiError | null] & QueryListResponse<(
  | ListResponse<K>
  | null
| undefined)[], K, ApiError>;

Defined in: lib/k8s/KubeObject.ts:379

Type Parameters

Type Parameter
`K` extends `KubeObject`<`any`>

Parameters

Parameter	Type
`this`	(...`args`: `any`) => `K` & typeof `KubeObject`
`__namedParameters`	`object` & `QueryParameters`

Returns

Inherited from

KubeObject.useList

Class: BackendTrafficPolicy

See​

Extends​

Constructors​

Constructor​

Parameters​

Returns​

Inherited from​

Properties​

Accessors​

cluster​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

detailsRoute​

Get Signature​

Returns​

Inherited from​

isNamespaced​

Get Signature​

Returns​

Inherited from​

isScalable​

Get Signature​

Returns​

Inherited from​

kind​

Get Signature​

Returns​

Inherited from​

listRoute​

Get Signature​

Returns​

Inherited from​

metadata​

Get Signature​

Returns​

Inherited from​

pluralName​

Get Signature​

Returns​

Inherited from​

retryConstraint​

Get Signature​

Returns​

sessionPersistence​

Get Signature​

Returns​

spec​

Get Signature​

Returns​

targetRefs​

Get Signature​

Returns​

apiEndpoint​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

apiGroupName​

Get Signature​

Returns​

Inherited from​

className​

Get Signature​

Returns​

Inherited from​

detailsRoute​

Get Signature​

Returns​

Inherited from​

listRoute​

Get Signature​

Returns​

Inherited from​

See

Extends

Constructors

Constructor

Parameters

Returns

Inherited from

Properties

Accessors

cluster

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

detailsRoute

Get Signature

Returns

Inherited from

isNamespaced

Get Signature

Returns

Inherited from

isScalable

Get Signature

Returns

Inherited from

kind

Get Signature

Returns

Inherited from

listRoute

Get Signature

Returns

Inherited from

metadata

Get Signature

Returns

Inherited from

pluralName

Get Signature

Returns

Inherited from

retryConstraint

Get Signature

Returns

sessionPersistence

Get Signature

Returns

spec

Get Signature

Returns

targetRefs

Get Signature

Returns

apiEndpoint

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

apiGroupName

Get Signature

Returns

Inherited from

className

Get Signature

Returns

Inherited from

detailsRoute

Get Signature

Returns

Inherited from

listRoute

Get Signature

Returns

Inherited from

pluralName