Class: Service

    lib/k8s/service .Service

    Hierarchy

    • any

      Service

    Constructors

    constructor

    new Service(json)

    Parameters

    Name Type
    json KubeService

    Inherited from

    makeKubeObject<KubeService>(‘service’).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/service.ts:43


    className

    Static className: string

    Inherited from

    makeKubeObject<KubeService>(‘service’).className

    Defined in

    lib/k8s/cluster.ts:318

    Accessors

    spec

    get spec(): Object

    Returns

    Object

    Name Type
    clusterIP string
    externalIPs string[]
    ports { name: string ; nodePort: number ; port: number ; protocol: string ; targetPort: string | number }[]
    selector { [key: string]: string; }
    type string

    Defined in

    lib/k8s/service.ts:45


    status

    get status(): any

    Returns

    any

    Defined in

    lib/k8s/service.ts:49

    Methods

    getExternalAddresses

    getExternalAddresses(): string

    Returns

    string

    Defined in

    lib/k8s/service.ts:53


    getPorts

    getPorts(): number[]

    Returns

    number[]

    Defined in

    lib/k8s/service.ts:63


    getSelector

    getSelector(): string[]

    Returns

    string[]

    Defined in

    lib/k8s/service.ts:67


    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<KubeService>(‘service’).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<KubeService>(‘service’).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<KubeService>(‘service’).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<KubeService>(‘service’).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<KubeService>(‘service’).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<KubeService>(‘service’).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<KubeService>(‘service’).useList

    Defined in

    lib/k8s/cluster.ts:309