Class KubernetesBackendClient

Implements

KubernetesApi

Index

Constructors

Methods

getCluster getClusters getCustomObjectsByEntity getObjectsByEntity getWorkloadsByEntity proxy

Constructors

constructor

new KubernetesBackendClient(
    options: {
        clustersCacheTtlMs?: number;
        discoveryApi: DiscoveryApi;
        fetchApi: FetchApi;
        kubernetesAuthProvidersApi: KubernetesAuthProvidersApi;
    },
): KubernetesBackendClient
Parameters
- options: {
      clustersCacheTtlMs?: number;
      discoveryApi: DiscoveryApi;
      fetchApi: FetchApi;
      kubernetesAuthProvidersApi: KubernetesAuthProvidersApi;
  }
  - OptionalclustersCacheTtlMs?: number
    When set, getClusters() results are cached for this many milliseconds. Useful when many proxy calls resolve cluster auth in quick succession.
  - discoveryApi: DiscoveryApi
  - fetchApi: FetchApi
  - kubernetesAuthProvidersApi: KubernetesAuthProvidersApi
Returns KubernetesBackendClient
- Defined in plugins/kubernetes-react/src/api/KubernetesBackendClient.ts:41

Methods

getCluster

getCluster(
clusterName: string,
): Promise<
{ authProvider: string; name: string; oidcTokenProvider?: string },
>
Parameters
- clusterName: string
Returns Promise<{ authProvider: string; name: string; oidcTokenProvider?: string }>
Implementation of KubernetesApi.getCluster
- Defined in plugins/kubernetes-react/src/api/KubernetesBackendClient.ts:99

getClusters

getClusters(): Promise<{ authProvider: string; name: string }[]>
Returns Promise<{ authProvider: string; name: string }[]>
Implementation of KubernetesApi.getClusters
- Defined in plugins/kubernetes-react/src/api/KubernetesBackendClient.ts:153

getCustomObjectsByEntity

getCustomObjectsByEntity(
request: CustomObjectsByEntityRequest,
): Promise<ObjectsByEntityResponse>
Parameters
- request: CustomObjectsByEntityRequest
Returns Promise<ObjectsByEntityResponse>
Implementation of KubernetesApi.getCustomObjectsByEntity
- Defined in plugins/kubernetes-react/src/api/KubernetesBackendClient.ts:143

getObjectsByEntity

getObjectsByEntity(
requestBody: KubernetesRequestBody,
): Promise<ObjectsByEntityResponse>
Parameters
- requestBody: KubernetesRequestBody
Returns Promise<ObjectsByEntityResponse>
Implementation of KubernetesApi.getObjectsByEntity
- Defined in plugins/kubernetes-react/src/api/KubernetesBackendClient.ts:125

getWorkloadsByEntity

getWorkloadsByEntity(
request: WorkloadsByEntityRequest,
): Promise<ObjectsByEntityResponse>
Parameters
- request: WorkloadsByEntityRequest
Returns Promise<ObjectsByEntityResponse>
Implementation of KubernetesApi.getWorkloadsByEntity
- Defined in plugins/kubernetes-react/src/api/KubernetesBackendClient.ts:134

proxy

proxy(
options: { clusterName: string; init?: RequestInit; path: string },
): Promise<Response>
Parameters
- options: { clusterName: string; init?: RequestInit; path: string }
Returns Promise<Response>
Implementation of KubernetesApi.proxy
- Defined in plugins/kubernetes-react/src/api/KubernetesBackendClient.ts:190