@k8slens/extensions

Globals / "src/renderer/api/endpoints/service.api" / Service

Class: Service

Hierarchy

• KubeObject

↳ Service

Implements

• ItemObject

Index

Constructors

• constructor

Properties

• apiVersion
• kind
• metadata
• spec
• status
• apiBase
• kind
• namespaced

Accessors

• selfLink

Methods

• delete
• getAge
• getAnnotations
• getClusterIp
• getExternalIps
• getFinalizers
• getId
• getLabels
• getLoadBalancer
• getName
• getNs
• getOwnerRefs
• getPorts
• getResourceVersion
• getSearchFields
• getSelector
• getStatus
• getType
• isActive
• toPlainObject
• update
• create
• isJsonApiData
• isJsonApiDataList
• isNonSystem
• stringifyLabels

Constructors

constructor

+ new Service(data: KubeJsonApiData): Service

Inherited from KubeObject.constructor

Defined in src/renderer/api/kube-object.ts:69

Parameters:

Name	Type
data	KubeJsonApiData

Returns: Service

Properties

apiVersion

• apiVersion: string

Inherited from KubeObject.apiVersion

Defined in src/renderer/api/kube-object.ts:75

---

kind

• kind: string

Inherited from KubeObject.kind

Defined in src/renderer/api/kube-object.ts:76

---

metadata

• metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

Defined in src/renderer/api/kube-object.ts:77

---

spec

• spec: { clusterIP: string ; externalIPs?: string[] ; externalTrafficPolicy?: string ; loadBalancerIP?: string ; ports: ServicePort[] ; selector: { [key:string]: string; } ; sessionAffinity: string ; type: string }

Defined in src/renderer/api/endpoints/service.api.ts:38

Type declaration:

Name	Type
clusterIP	string
externalIPs?	string[]
externalTrafficPolicy?	string
loadBalancerIP?	string
ports	ServicePort[]
selector	{ [key:string]: string; }
sessionAffinity	string
type	string

---

status

• status: { loadBalancer?: { ingress?: { hostname?: string ; ip?: string }[] } }

Overrides KubeObject.status

Defined in src/renderer/api/endpoints/service.api.ts:49

Type declaration:

Name	Type
loadBalancer?	{ ingress?: { hostname?: string ; ip?: string }[] }

---

apiBase

▪ Static apiBase: string = "/api/v1/services"

Defined in src/renderer/api/endpoints/service.api.ts:36

---

kind

▪ Static kind: string = "Service"

Overrides KubeObject.kind

Defined in src/renderer/api/endpoints/service.api.ts:34

---

namespaced

▪ Static namespaced: boolean = true

Overrides KubeObject.namespaced

Defined in src/renderer/api/endpoints/service.api.ts:35

Accessors

selfLink

• get selfLink(): string

Inherited from KubeObject.selfLink

Defined in src/renderer/api/kube-object.ts:80

Returns: string

Methods

delete

▸ delete(params?: JsonApiParams): CancelablePromise\<KubeJsonApiData>

Inherited from KubeObject.delete

Defined in src/renderer/api/kube-object.ts:160

Parameters:

Name	Type
params?	JsonApiParams

Returns: CancelablePromise\<KubeJsonApiData>

---

getAge

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

Inherited from KubeObject.getAge

Defined in src/renderer/api/kube-object.ts:102

Parameters:

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

Returns: string | number

---

getAnnotations

▸ getAnnotations(filter?: boolean): string[]

Inherited from KubeObject.getAnnotations

Defined in src/renderer/api/kube-object.ts:121

Parameters:

Name	Type	Default value
filter	boolean	false

Returns: string[]

---

getClusterIp

▸ getClusterIp(): string

Defined in src/renderer/api/endpoints/service.api.ts:58

Returns: string

---

getExternalIps

▸ getExternalIps(): string[]

Defined in src/renderer/api/endpoints/service.api.ts:62

Returns: string[]

---

getFinalizers

▸ getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

Defined in src/renderer/api/kube-object.ts:113

Returns: string[]

---

getId

▸ getId(): string

Implementation of ItemObject

Inherited from KubeObject.getId

Defined in src/renderer/api/kube-object.ts:84

Returns: string

---

getLabels

▸ getLabels(): string[]

Inherited from KubeObject.getLabels

Defined in src/renderer/api/kube-object.ts:117

Returns: string[]

---

getLoadBalancer

▸ getLoadBalancer(): object

Defined in src/renderer/api/endpoints/service.api.ts:84

Returns: object

Name	Type
ingress?	{ hostname?: string ; ip?: string }[]

---

getName

▸ getName(): string

Implementation of ItemObject

Inherited from KubeObject.getName

Defined in src/renderer/api/kube-object.ts:92

Returns: string

---

getNs

▸ getNs(): string

Inherited from KubeObject.getNs

Defined in src/renderer/api/kube-object.ts:96

Returns: string

---

getOwnerRefs

▸ getOwnerRefs(): { namespace: string = this.getNs() }[]

Inherited from KubeObject.getOwnerRefs

Defined in src/renderer/api/kube-object.ts:129

Returns: { namespace: string = this.getNs() }[]

---

getPorts

▸ getPorts(): ServicePort[]

Defined in src/renderer/api/endpoints/service.api.ts:79

Returns: ServicePort[]

---

getResourceVersion

▸ getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

Defined in src/renderer/api/kube-object.ts:88

Returns: string

---

getSearchFields

▸ getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

Defined in src/renderer/api/kube-object.ts:137

Returns: string[]

---

getSelector

▸ getSelector(): string[]

Defined in src/renderer/api/endpoints/service.api.ts:74

Returns: string[]

---

getStatus

▸ getStatus(): \"Active\" | \"Pending\"

Defined in src/renderer/api/endpoints/service.api.ts:92

Returns: \"Active\" | \"Pending\"

---

getType

▸ getType(): string

Defined in src/renderer/api/endpoints/service.api.ts:70

Returns: string

---

isActive

▸ isActive(): boolean

Defined in src/renderer/api/endpoints/service.api.ts:88

Returns: boolean

---

toPlainObject

▸ toPlainObject(): object

Inherited from KubeObject.toPlainObject

Defined in src/renderer/api/kube-object.ts:148

Returns: object

---

update

▸ update\(data: Partial\): Promise\

Inherited from KubeObject.update

Defined in src/renderer/api/kube-object.ts:153

Type parameters:

Name	Type
T	KubeObject

Parameters:

Name	Type
data	Partial\

Returns: Promise\

---

create

▸ Staticcreate(data: any): KubeObject

Inherited from KubeObject.create

Defined in src/renderer/api/kube-object.ts:50

Parameters:

Name	Type
data	any

Returns: KubeObject

---

isJsonApiData

▸ StaticisJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

Defined in src/renderer/api/kube-object.ts:58

Parameters:

Name	Type
object	any

Returns: object is KubeJsonApiData

---

isJsonApiDataList

▸ StaticisJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

Defined in src/renderer/api/kube-object.ts:62

Parameters:

Name	Type
object	any

Returns: object is KubeJsonApiDataList

---

isNonSystem

▸ StaticisNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

Defined in src/renderer/api/kube-object.ts:54

Parameters:

Name	Type
item	KubeJsonApiData | KubeObject

Returns: boolean

---

stringifyLabels

▸ StaticstringifyLabels(labels: { [name:string]: string; }): string[]

Inherited from KubeObject.stringifyLabels

Defined in src/renderer/api/kube-object.ts:66

Parameters:

Name	Type
labels	{ [name:string]: string; }

Returns: string[]

---

Last update: November 10, 2020