Class: Ingress

Extends

• any

Constructors

new Ingress()

new Ingress(json: KubeIngress): Ingress

Parameters

Parameter	Type
json	KubeIngress

Returns

Ingress

Inherited from

makeKubeObject<KubeIngress>('ingress').constructor

Defined in

src/lib/k8s/cluster.ts:337

Properties

Property	Modifier	Type	Inherited from	Defined in
apiEndpoint	static	ApiWithNamespaceClient<KubeObjectInterface>	-	src/lib/k8s/ingress.ts:72
apiList	static	(onList: (arg: any[]) => void, onError?: (err: ApiError) => void, opts?: ApiListSingleNamespaceOptions) => any	makeKubeObject<KubeIngress>('ingress').apiList	src/lib/k8s/cluster.ts:311
className	static	string	makeKubeObject<KubeIngress>('ingress').className	src/lib/k8s/cluster.ts:338
getAuthorization?	static	(arg: string, resourceAttrs?: AuthRequestResourceAttrs) => any	makeKubeObject<KubeIngress>('ingress').getAuthorization	src/lib/k8s/cluster.ts:340
getErrorMessage	static	(err?: null | ApiError) => null | string	makeKubeObject<KubeIngress>('ingress').getErrorMessage	src/lib/k8s/cluster.ts:336
useApiGet	static	(onGet: (...args: any) => void, name: string, namespace?: string, onError?: (err: ApiError) => void) => void	makeKubeObject<KubeIngress>('ingress').useApiGet	src/lib/k8s/cluster.ts:321
useApiList	static	(onList: (arg: any[]) => void, onError?: (err: ApiError) => void, opts?: ApiListOptions) => any	makeKubeObject<KubeIngress>('ingress').useApiList	src/lib/k8s/cluster.ts:316
useGet	static	(name: string, namespace?: string, opts?: object) => [any, null | ApiError] & QueryResponse<any, ApiError>	makeKubeObject<KubeIngress>('ingress').useGet	src/lib/k8s/cluster.ts:328

Accessors

spec

get spec(): object

Returns

object

defaultBackend?

optional defaultBackend: object;

defaultBackend.resource?

optional resource: object;

defaultBackend.resource.apiVersion

apiVersion: string;

defaultBackend.resource.kind

kind: string;

defaultBackend.resource.name

name: string;

defaultBackend.service?

optional service: object;

defaultBackend.service.name

name: string;

defaultBackend.service.port

port: object;

defaultBackend.service.port.name?

optional name: string;

defaultBackend.service.port.number?

optional number: number;

ingressClassName?

optional ingressClassName: string;

rules

rules: IngressRule[] | LegacyIngressRule[];

tls?

optional tls: object[];

Defined in

src/lib/k8s/ingress.ts:79

---

listRoute

get static listRoute(): string

Returns

string

Defined in

src/lib/k8s/ingress.ts:133

---

pluralName

get static pluralName(): string

Returns

string

Defined in

src/lib/k8s/ingress.ts:137

Methods

getHosts()

getHosts(): string

Returns

string

Defined in

src/lib/k8s/ingress.ts:83

---

getRules()

getRules(): IngressRule[]

Returns

IngressRule[]

Defined in

src/lib/k8s/ingress.ts:87

---

useList()

static useList(options?: ApiListOptions): [null | any[], null | ApiError] & QueryListResponse<KubeList<any>, any, ApiError>

Parameters

Parameter	Type
options?	ApiListOptions

Returns

[null | any[], null | ApiError] & QueryListResponse<KubeList<any>, any, ApiError>

Inherited from

makeKubeObject<KubeIngress>('ingress').useList

Defined in

src/lib/k8s/cluster.ts:327