Class K8ClientServices

The abstract K8 Client Filter adds the filterItem method to the class that extends it.

Hierarchy (View Summary)

K8ClientBase
- K8ClientServices

Implements

Services

Index

Constructors

Methods

create filterItem list read wrapObjectMeta

Constructors

constructor

new K8ClientServices(kubeClient: CoreV1Api): K8ClientServices
Parameters
- kubeClient: CoreV1Api
Returns K8ClientServices
Overrides K8ClientBase.constructor
- Defined in src/integration/kube/k8-client/resources/service/k8-client-services.ts:19

Methods

create

create(
    serviceReference: ServiceReference,
    labels: Record<string, string>,
    servicePort: number,
    podTargetPort: number,
): Promise<Service>
Create a service
Parameters
- serviceReference: ServiceReference
- labels: Record<string, string>
  the labels for the service
- servicePort: number
  the service port
- podTargetPort: number
  the target port
Returns Promise<Service>
the service

Throws
if the service could not be created
Implementation of Services.create
- Defined in src/integration/kube/k8-client/resources/service/k8-client-services.ts:59

`Protected`filterItem

filterItem(items: any[], filters?: Record<string, string>): any
Filter a single item using metadata filter
Parameters
- items: any[]
  list of items
- Optionalfilters: Record<string, string> = {}
  an object with metadata fields and value
Returns any
Throws
SoloError - multiple items found with filters

Throws
MissingArgumentError - filters are required
Inherited from K8ClientBase.filterItem
- Defined in src/integration/kube/k8-client/k8-client-base.ts:57

list

list(namespace: NamespaceName, labels?: string[]): Promise<Service[]>
List all services in a namespace
Parameters
- namespace: NamespaceName
  namespace
- Optionallabels: string[]
  labels
Returns Promise<Service[]>
Implementation of Services.list
- Defined in src/integration/kube/k8-client/resources/service/k8-client-services.ts:23

read

read(namespace: NamespaceName, name: string): Promise<Service>
Get a svc by name
Parameters
- namespace: NamespaceName
  namespace
- name: string
  service name
Returns Promise<Service>
Implementation of Services.read
- Defined in src/integration/kube/k8-client/resources/service/k8-client-services.ts:39

`Protected`wrapObjectMeta

wrapObjectMeta(v1meta: V1ObjectMeta): ObjectMeta
Wraps the V1ObjectMeta object instance into a ObjectMeta instance.
Parameters
- v1meta: V1ObjectMeta
  the V1ObjectMeta object from the K8S API client.
Returns ObjectMeta
Inherited from K8ClientBase.wrapObjectMeta
- Defined in src/integration/kube/k8-client/k8-client-base.ts:70