Packages

c

com.coralogix.zio.k8s.client.impl

SubresourceClient

final class SubresourceClient[T] extends Subresource[T] with ResourceClientBase

Generic implementation for Subresource

T

Subresource type

Linear Supertypes
ResourceClientBase, Subresource[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SubresourceClient
  2. ResourceClientBase
  3. Subresource
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SubresourceClient(resourceType: K8sResourceType, cluster: K8sCluster, backend: K8sBackend, subresourceName: String)(implicit arg0: Encoder[T], arg1: Decoder[T])

    resourceType

    Kubernetes resource metadata

    cluster

    Configured Kubernetes cluster

    backend

    Configured HTTP client

    subresourceName

    Name of the subresource

Value Members

  1. def create(name: String, value: T, namespace: Option[K8sNamespace], dryRun: Boolean): IO[K8sFailure, T]

    Creates a new subresource for a resource given by its name

    Creates a new subresource for a resource given by its name

    name

    Name of thte resource

    value

    Subresource to create

    namespace

    Namespace. For namespaced resources it must be Some, for cluster resources it must be None.

    dryRun

    If true, the request is sent to the server but it will not create the resource.

    returns

    The created subresource returned from the Kubernetes server

    Definition Classes
    SubresourceClient → Subresource
  2. def get(name: String, namespace: Option[K8sNamespace], customParameters: Map[String, String] = Map.empty): IO[K8sFailure, T]

    Get the subresource by the resource's name

    Get the subresource by the resource's name

    name

    Name of the resource

    namespace

    Namespace. For namespaced resources it must be Some, for cluster resources it must be None.

    customParameters

    A set of custom query parameters to pass to the Kubernetes API

    returns

    The queried subresource

    Definition Classes
    SubresourceClient → Subresource
  3. def replace(name: String, updatedValue: T, namespace: Option[K8sNamespace], dryRun: Boolean): IO[K8sFailure, T]

    Replaces the subresource given by its resource name

    Replaces the subresource given by its resource name

    name

    Name of the resource

    updatedValue

    Updated subresource value

    namespace

    Namespace. For namespaced resources it must be Some, for cluster resources it must be None.

    dryRun

    If true, the request is sent to the server but it will not create the resource.

    returns

    The updated subresource value returned from the Kubernetes server

    Definition Classes
    SubresourceClient → Subresource
  4. def streamingGet(name: String, namespace: Option[K8sNamespace], pipeline: ZPipeline[Any, K8sFailure, Byte, T], customParameters: Map[String, String] = Map.empty): ZStream[Any, K8sFailure, T]

    Get the subresource in a streaming way

    Get the subresource in a streaming way

    name

    Name of the resource

    namespace

    Namespace. For namespaced resources it must be Some, for cluster resources it must be None.

    customParameters

    A set of custom query parameters to pass to the Kubernetes API

    returns

    A stream of the subresource type

    Definition Classes
    SubresourceClient → Subresource