Class: Ingress
lib/k8s/ingress .Ingress
Hierarchy
-
any↳
Ingress
Constructors
constructor
• new Ingress(json)
Parameters
| Name | Type |
|---|---|
json |
KubeIngress
|
Inherited from
makeKubeObject<KubeIngress>(‘ingress’).constructor
Defined in
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
className
▪ Static className: string
Inherited from
makeKubeObject<KubeIngress>(‘ingress’).className
Defined in
Accessors
listRoute
• get listRoute(): string
Returns
string
Defined in
spec
• get spec(): Object
Returns
Object
| Name | Type |
|---|---|
rules |
{ host: string ; http: { paths: { backend: { serviceName: string ; servicePort: string } ; path: string }[] } }[] |
Defined in
pluralName
• Static get pluralName(): string
Returns
string
Defined in
Methods
getHosts
▸ getHosts(): string
Returns
string
Defined in
apiList
▸ Static apiList(onList): any
Parameters
| Name | Type |
|---|---|
onList |
(arg: any[]) => void |
Returns
any
Inherited from
makeKubeObject<KubeIngress>(‘ingress’).apiList
Defined in
getErrorMessage
▸ Static getErrorMessage(err?): null | string
Parameters
| Name | Type |
|---|---|
err? |
null |
ApiError
|
Returns
null | string
Inherited from
makeKubeObject<KubeIngress>(‘ingress’).getErrorMessage
Defined in
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
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
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
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