Packages

trait Subresource[T] extends AnyRef

Generic interface for subresources.

Every subresource supports a different subset of these operations, so usually you should use the actual generated subresource interfaces instead.

T

Subresource type

Linear Supertypes
AnyRef, Any
Known Subclasses
SubresourceClient, TestSubresourceClient
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Subresource
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract 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

  2. abstract 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

  3. abstract 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

  4. abstract def streamingGet(name: String, namespace: Option[K8sNamespace], transducer: 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.

    transducer

    Transducer to transform the response byte stream to the subresource type

    customParameters

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

    returns

    A stream of the subresource type