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

    lib/k8s/cluster.ts:317

    Properties

    apiEndpoint

    Static apiEndpoint: Object

    Index signature

    ▪ [other: string]: any

    Type declaration

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

    Defined in

    lib/k8s/ingress.ts:72


    className

    Static className: string

    Inherited from

    makeKubeObject<KubeIngress>(‘ingress’).className

    Defined in

    lib/k8s/cluster.ts:318

    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:79


    listRoute

    Static get listRoute(): string

    Returns

    string

    Defined in

    lib/k8s/ingress.ts:126


    pluralName

    Static get pluralName(): string

    Returns

    string

    Defined in

    lib/k8s/ingress.ts:130

    Methods

    getHosts

    getHosts(): string

    Returns

    string

    Defined in

    lib/k8s/ingress.ts:83


    getRules

    getRules(): IngressRule []

    Returns

    IngressRule []

    Defined in

    lib/k8s/ingress.ts:87


    apiList

    Static apiList(onList, onError?, opts?): any

    Parameters

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

    Returns

    any

    Inherited from

    makeKubeObject<KubeIngress>(‘ingress’).apiList

    Defined in

    lib/k8s/cluster.ts:293


    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:320


    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:316


    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:303


    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:298


    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:312


    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:309