Skip to content

Class: Service#

Renderer.K8sApi.Service

Hierarchy#

Service

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

new Service(data)

Parameters#

Name Type
data KubeJsonApiData<NamespaceScopedMetadata, ServiceStatus, ServiceSpec>

Inherited from#

KubeObject.constructor

Properties#

apiVersion#

apiVersion: string

Inherited from#

KubeObject.apiVersion


kind#

kind: string

Inherited from#

KubeObject.kind


metadata#

metadata: NamespaceScopedMetadata

Inherited from#

KubeObject.metadata


spec#

spec: ServiceSpec

Inherited from#

KubeObject.spec


status#

Optional status: ServiceStatus

Inherited from#

KubeObject.status


apiBase#

Static Readonly apiBase: "/api/v1/services"

Overrides#

KubeObject.apiBase


kind#

Static Readonly kind: "Service"

Overrides#

KubeObject.kind


namespaced#

Static Readonly namespaced: true

Overrides#

KubeObject.namespaced

Accessors#

get selfLink(): string

Returns#

string

Inherited from#

KubeObject.selfLink

Methods#

delete#

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

deprecated use KubeApi.delete instead

Parameters#

Name Type
params? object

Returns#

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

Inherited from#

KubeObject.delete


getAge#

getAge(humanize?, compact?, fromNow?): string | number

deprecated This function computes a new "now" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering

Parameters#

Name Type Default value
humanize boolean true
compact boolean true
fromNow boolean false

Returns#

string | number

Inherited from#

KubeObject.getAge


getAnnotations#

getAnnotations(filter?): string[]

Parameters#

Name Type Default value
filter boolean false

Returns#

string[]

Inherited from#

KubeObject.getAnnotations


getClusterIp#

getClusterIp(): string

Returns#

string


getClusterIps#

getClusterIps(): string[]

Returns#

string[]


getCreationTimestamp#

getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

Returns#

number

Inherited from#

KubeObject.getCreationTimestamp


getExternalIps#

getExternalIps(): (undefined | string)[]

Returns#

(undefined | string)[]


getFinalizers#

getFinalizers(): string[]

Returns#

string[]

Inherited from#

KubeObject.getFinalizers


getId#

getId(): string

Returns#

string

Inherited from#

KubeObject.getId


getIpFamilies#

getIpFamilies(): string[]

Returns#

string[]


getIpFamilyPolicy#

getIpFamilyPolicy(): string

Returns#

string


getLabels#

getLabels(): string[]

Returns#

string[]

Inherited from#

KubeObject.getLabels


getLoadBalancer#

getLoadBalancer(): undefined | { ingress?: { hostname?: string ; ip?: string }[] }

Returns#

undefined | { ingress?: { hostname?: string ; ip?: string }[] }


getName#

getName(): string

Returns#

string

Inherited from#

KubeObject.getName


getNs#

getNs(): string

Returns#

string

Inherited from#

KubeObject.getNs


getOwnerRefs#

getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

Returns#

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

Inherited from#

KubeObject.getOwnerRefs


getPorts#

getPorts(): ServicePort[]

Returns#

ServicePort[]


getResourceVersion#

getResourceVersion(): string

Returns#

string

Inherited from#

KubeObject.getResourceVersion


getScopedName#

getScopedName(): string

Returns#

string

Inherited from#

KubeObject.getScopedName


getSearchFields#

getSearchFields(): string[]

Returns#

string[]

Inherited from#

KubeObject.getSearchFields


getSelector#

getSelector(): string[]

Returns#

string[]


getStatus#

getStatus(): "Active" | "Pending"

Returns#

"Active" | "Pending"


getTimeDiffFromNow#

getTimeDiffFromNow(): number

deprecated This function computes a new "now" on every call which might cause subtle issues if called multiple times

NOTE: Generally you can use getCreationTimestamp instead.

Returns#

number

Inherited from#

KubeObject.getTimeDiffFromNow


getType#

getType(): string

Returns#

string


isActive#

isActive(): boolean

Returns#

boolean


patch#

patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

deprecated use KubeApi.patch instead

Parameters#

Name Type
patch Patch

Returns#

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

Inherited from#

KubeObject.patch


toPlainObject#

toPlainObject(): JsonObject

Returns#

JsonObject

Inherited from#

KubeObject.toPlainObject


update#

update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Perform a full update (or more specifically a replace)

Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.

deprecated use KubeApi.update instead

Parameters#

Name Type
data Partial<Service>

Returns#

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

Inherited from#

KubeObject.update


create#

Static create<Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Type parameters#

Name Type
Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope>
Status unknown
Spec unknown

Parameters#

Name Type
data KubeJsonApiData<Metadata, Status, Spec>

Returns#

KubeObject<Metadata, Status, Spec>

Inherited from#

KubeObject.create


isJsonApiData#

Static isJsonApiData(object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Parameters#

Name Type
object unknown

Returns#

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Inherited from#

KubeObject.isJsonApiData


isJsonApiDataList#

Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

Type parameters#

Name
T

Parameters#

Name Type
object unknown
verifyItem (val: unknown) => val is T

Returns#

object is KubeJsonApiDataList<T>

Inherited from#

KubeObject.isJsonApiDataList


isKubeJsonApiListMetadata#

Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

Parameters#

Name Type
object unknown

Returns#

object is KubeJsonApiListMetadata

Inherited from#

KubeObject.isKubeJsonApiListMetadata


isKubeJsonApiMetadata#

Static isKubeJsonApiMetadata(object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Parameters#

Name Type
object unknown

Returns#

object is KubeJsonApiObjectMetadata<KubeObjectScope>

Inherited from#

KubeObject.isKubeJsonApiMetadata


isNonSystem#

Static isNonSystem(item): boolean

Parameters#

Name Type
item KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>

Returns#

boolean

Inherited from#

KubeObject.isNonSystem


isPartialJsonApiData#

Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Parameters#

Name Type
object unknown

Returns#

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Inherited from#

KubeObject.isPartialJsonApiData


isPartialJsonApiMetadata#

Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Parameters#

Name Type
object unknown

Returns#

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Inherited from#

KubeObject.isPartialJsonApiMetadata


stringifyLabels#

Static stringifyLabels(labels?): string[]

Parameters#

Name Type
labels? Partial<Record<string, string>>

Returns#

string[]

Inherited from#

KubeObject.stringifyLabels