Subresource

trait Subresource[T]

Generic interface for subresources.

Generic interface for subresources.

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

Type Params
T

Subresource type

class Object
trait Matchable
class Any

Value members

Abstract methods

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

Value Params
dryRun

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

name

Name of thte resource

namespace

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

value

Subresource to create

Returns

The created subresource returned from the Kubernetes server

def get(name: String, namespace: Option[K8sNamespace], customParameters: Map[String, String]): IO[K8sFailure, T]

Get the subresource by the resource's name

Get the subresource by the resource's name

Value Params
customParameters

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

name

Name of the resource

namespace

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

Returns

The queried subresource

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

Value Params
dryRun

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

name

Name of the resource

namespace

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

updatedValue

Updated subresource value

Returns

The updated subresource value returned from the Kubernetes server

def streamingGet(name: String, namespace: Option[K8sNamespace], transducer: ZTransducer[Any, K8sFailure, Byte, T], customParameters: Map[String, String]): ZStream[Any, K8sFailure, T]

Get the subresource in a streaming way

Get the subresource in a streaming way

Value Params
customParameters

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

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

Returns

A stream of the subresource type