Skip to content

Class: PodsApi#

Renderer.K8sApi.PodsApi

Hierarchy#

PodsApi

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

new PodsApi(opts?)

Parameters#

Name Type
opts DerivedKubeApiOptions & IgnoredKubeApiOptions

Overrides#

KubeApi.constructor

Properties#

apiBase#

apiBase: string

Inherited from#

KubeApi.apiBase


apiGroup#

apiGroup: string

Inherited from#

KubeApi.apiGroup


apiPrefix#

apiPrefix: string

Inherited from#

KubeApi.apiPrefix


apiResource#

Readonly apiResource: string

Inherited from#

KubeApi.apiResource


apiVersion#

Readonly apiVersion: string

Inherited from#

KubeApi.apiVersion


apiVersionPreferred#

apiVersionPreferred: undefined | string

Inherited from#

KubeApi.apiVersionPreferred


doCheckPreferredVersion#

Protected Readonly doCheckPreferredVersion: boolean

Inherited from#

KubeApi.doCheckPreferredVersion


fallbackApiBases#

Protected Readonly fallbackApiBases: undefined | string[]

Inherited from#

KubeApi.fallbackApiBases


fullApiPathname#

Protected Readonly fullApiPathname: string

Inherited from#

KubeApi.fullApiPathname


isNamespaced#

Readonly isNamespaced: boolean

Inherited from#

KubeApi.isNamespaced


kind#

Readonly kind: string

Inherited from#

KubeApi.kind


objectConstructor#

Readonly objectConstructor: KubeObjectConstructor<Pod, KubeJsonApiData<NamespaceScopedMetadata, PodStatus, PodSpec>>

Inherited from#

KubeApi.objectConstructor


request#

Protected Readonly request: KubeJsonApi

Inherited from#

KubeApi.request


resourceVersions#

Protected Readonly resourceVersions: Map<string, string>

Inherited from#

KubeApi.resourceVersions


watchDisposer#

Protected Readonly watchDisposer: undefined | Disposer

Inherited from#

KubeApi.watchDisposer

Accessors#

apiVersionWithGroup#

get apiVersionWithGroup(): string

Returns#

string

Inherited from#

KubeApi.apiVersionWithGroup

Methods#

checkPreferredVersion#

Protected checkPreferredVersion(): Promise<void>

Returns#

Promise<void>

Inherited from#

KubeApi.checkPreferredVersion


create#

create(__namedParameters, partialData?): Promise<null | Pod>

Parameters#

Name Type
__namedParameters Partial<ResourceDescriptor>
partialData? PartialObjectDeep<Pod>

Returns#

Promise<null | Pod>

Inherited from#

KubeApi.create


delete#

delete(__namedParameters): Promise<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Parameters#

Name Type
__namedParameters DeleteResourceDescriptor

Returns#

Promise<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Inherited from#

KubeApi.delete


get#

get(desc, query?): Promise<null | Pod>

Parameters#

Name Type
desc ResourceDescriptor
query? KubeApiQueryParams

Returns#

Promise<null | Pod>

Inherited from#

KubeApi.get


getLogs#

getLogs(params, query?): Promise<string>

Parameters#

Name Type
params ResourceDescriptor
query? PodLogsQuery

Returns#

Promise<string>


getResourceVersion#

getResourceVersion(namespace?): undefined | string

Parameters#

Name Type Default value
namespace string ""

Returns#

undefined | string

Inherited from#

KubeApi.getResourceVersion


getUrl#

getUrl(__namedParameters?, query?): string

Parameters#

Name Type
__namedParameters Partial<ResourceDescriptor>
query? Partial<KubeApiQueryParams>

Returns#

string

Inherited from#

KubeApi.getUrl


getWatchUrl#

getWatchUrl(namespace?, query?): string

Parameters#

Name Type Default value
namespace string ""
query KubeApiQueryParams {}

Returns#

string

Inherited from#

KubeApi.getWatchUrl


list#

list(__namedParameters?, query?): Promise<null | Pod[]>

Parameters#

Name Type
__namedParameters KubeApiListOptions
query? KubeApiQueryParams

Returns#

Promise<null | Pod[]>

Inherited from#

KubeApi.list


modifyWatchEvent#

Protected modifyWatchEvent(event): void

Parameters#

Name Type
event IKubeWatchEvent<KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>>

Returns#

void

Inherited from#

KubeApi.modifyWatchEvent


normalizeQuery#

Protected normalizeQuery(query?): Partial<KubeApiQueryParams>

Parameters#

Name Type
query Partial<KubeApiQueryParams>

Returns#

Partial<KubeApiQueryParams>

Inherited from#

KubeApi.normalizeQuery


parseResponse#

Protected parseResponse(data, namespace?): null | Pod | Pod[]

Parameters#

Name Type
data unknown
namespace? string

Returns#

null | Pod | Pod[]

Inherited from#

KubeApi.parseResponse


patch#

patch(desc, data, strategy?): Promise<null | Pod>

Parameters#

Name Type Default value
desc ResourceDescriptor undefined
data Patch | PartialObjectDeep<Pod> undefined
strategy KubeApiPatchType "strategic"

Returns#

Promise<null | Pod>

Inherited from#

KubeApi.patch


refreshResourceVersion#

refreshResourceVersion(params?): Promise<null | Pod[]>

Parameters#

Name Type
params? KubeApiListOptions

Returns#

Promise<null | Pod[]>

Inherited from#

KubeApi.refreshResourceVersion


setResourceVersion#

setResourceVersion(namespace?, newVersion): void

Parameters#

Name Type Default value
namespace string ""
newVersion string undefined

Returns#

void

Inherited from#

KubeApi.setResourceVersion


update#

update(__namedParameters, data): Promise<null | Pod>

Parameters#

Name Type
__namedParameters ResourceDescriptor
data PartialObjectDeep<Pod>

Returns#

Promise<null | Pod>

Inherited from#

KubeApi.update


watch#

watch(opts?): () => void

Parameters#

Name Type
opts KubeApiWatchOptions<Pod, KubeJsonApiData<NamespaceScopedMetadata, PodStatus, PodSpec>>

Returns#

fn

▸ (): void

Returns#

void

Inherited from#

KubeApi.watch