Class: Ingress

Hierarchy

any

↳ Ingress

Constructors

constructor

• new Ingress(json)

Parameters

Name	Type
`json`	`KubeIngress`

Inherited from

makeKubeObject<KubeIngress>(‘ingress’).constructor

Defined in

lib/k8s/cluster.ts:107

Properties

apiEndpoint

▪ Static apiEndpoint: Object

Index signature

▪ [other: string]: any

Type declaration

Name	Type
`scale?`	{ `get`: (`namespace`: `string`, `name`: `string`) => `Promise`<`any`> ; `put`: (`body`: { `metadata`: `KubeMetadata` ; `spec`: { `replicas`: `number` } }) => `Promise`<`any`> }
`scale.get`	(`namespace`: `string`, `name`: `string`) => `Promise`<`any`>
`scale.put`	(`body`: { `metadata`: `KubeMetadata` ; `spec`: { `replicas`: `number` } }) => `Promise`<`any`>

Defined in

lib/k8s/ingress.ts:65

className

▪ Static className: string

Inherited from

makeKubeObject<KubeIngress>(‘ingress’).className

Defined in

lib/k8s/cluster.ts:108

Accessors

spec

• get spec(): Object

Returns

Object

Name	Type
`defaultBackend?`	{ `resource?`: { `apiVersion`: `string` ; `kind`: `string` ; `name`: `string` } ; `service?`: { `name`: `string` ; `port`: { `name?`: `string` ; `number?`: `number` } } }
`defaultBackend.resource?`	{ `apiVersion`: `string` ; `kind`: `string` ; `name`: `string` }
`defaultBackend.resource.apiVersion`	`string`
`defaultBackend.resource.kind`	`string`
`defaultBackend.resource.name`	`string`
`defaultBackend.service?`	{ `name`: `string` ; `port`: { `name?`: `string` ; `number?`: `number` } }
`defaultBackend.service.name`	`string`
`defaultBackend.service.port`	{ `name?`: `string` ; `number?`: `number` }
`defaultBackend.service.port.name?`	`string`
`defaultBackend.service.port.number?`	`number`
`ingressClassName`	`string`
`rules`	`IngressRule` [] \| `LegacyIngressRule`[]
`tls?`	{ `hosts`: `string`[] ; `secretName`: `string` }[]

Defined in

lib/k8s/ingress.ts:72

listRoute

• Static get listRoute(): string

Returns

string

Defined in

lib/k8s/ingress.ts:119

pluralName

• Static get pluralName(): string

Returns

string

Defined in

lib/k8s/ingress.ts:123

Methods

getHosts

▸ getHosts(): string

Returns

string

Defined in

lib/k8s/ingress.ts:76

getRules

▸ getRules(): IngressRule []

Returns

IngressRule []

Defined in

lib/k8s/ingress.ts:80

apiList

▸ Static apiList(onList): any

Parameters

Name	Type
`onList`	(`arg`: `any`[]) => `void`

Returns

any

Inherited from

makeKubeObject<KubeIngress>(‘ingress’).apiList

Defined in

lib/k8s/cluster.ts:87

getAuthorization

▸ Static Optional getAuthorization(arg, resourceAttrs?): any

Parameters

Name	Type
`arg`	`string`
`resourceAttrs?`	`AuthRequestResourceAttrs`

Returns

any

Inherited from

makeKubeObject<KubeIngress>(‘ingress’).getAuthorization

Defined in

lib/k8s/cluster.ts:110

getErrorMessage

▸ Static getErrorMessage(err?): null | string

Parameters

Name	Type
`err?`	`null` \| `ApiError`

Returns

null | string

Inherited from

makeKubeObject<KubeIngress>(‘ingress’).getErrorMessage

Defined in

lib/k8s/cluster.ts:106

useApiGet

▸ Static useApiGet(onGet, name, namespace?, onError?): void

Parameters

Name	Type
`onGet`	(…`args`: `any`) => `void`
`name`	`string`
`namespace?`	`string`
`onError?`	(`err`: `ApiError` ) => `void`

Returns

void

Inherited from

makeKubeObject<KubeIngress>(‘ingress’).useApiGet

Defined in

lib/k8s/cluster.ts:93

useApiList

▸ Static useApiList(onList, onError?, opts?): any

Parameters

Name	Type
`onList`	(`arg`: `any`[]) => `void`
`onError?`	(`err`: `ApiError` ) => `void`
`opts?`	`ApiListOptions`

Returns

any

Inherited from

makeKubeObject<KubeIngress>(‘ingress’).useApiList

Defined in

lib/k8s/cluster.ts:88

useGet

▸ Static useGet(name, namespace?): [any, null | ApiError , (item: any) => void, (err: null | ApiError ) => void]

Parameters

Name	Type
`name`	`string`
`namespace?`	`string`

Returns

[any, null | ApiError , (item: any) => void, (err: null | ApiError ) => void]

Inherited from

makeKubeObject<KubeIngress>(‘ingress’).useGet

Defined in

lib/k8s/cluster.ts:102

useList

▸ Static useList(opts?): [any[], null | ApiError , (items: any[]) => void, (err: null | ApiError ) => void]

Parameters

Name	Type
`opts?`	`ApiListOptions`

Returns

[any[], null | ApiError , (items: any[]) => void, (err: null | ApiError ) => void]

Inherited from

makeKubeObject<KubeIngress>(‘ingress’).useList

Defined in

lib/k8s/cluster.ts:99