zio-k8s-client
API
Generated with
zio-k8s-client/com.coralogix.zio.k8s/com.coralogix.zio.k8s.client/com.coralogix.zio.k8s.client.impl/SubresourceClient

SubresourceClient

com.coralogix.zio.k8s.client.impl.SubresourceClient
final class SubresourceClient[T](val resourceType: K8sResourceType, val cluster: K8sCluster, val backend: SttpBackend[Task, ZioStreams & WebSockets], subresourceName: String)(implicit evidence$1: Encoder[T], evidence$2: Decoder[T]) extends Subresource[T], ResourceClientBase

Generic implementation for Subresource

Type parameters

T

Subresource type

Value parameters

backend

Configured HTTP client

cluster

Configured Kubernetes cluster

resourceType

Kubernetes resource metadata

subresourceName

Name of the subresource

Attributes

Graph
Supertypes
trait Subresource[T]
class Object
trait Matchable
class Any

Members list

Value members

Concrete 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 parameters

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

Attributes

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 parameters

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.

Attributes

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 parameters

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

Attributes

Returns

The updated subresource value returned from the Kubernetes server

def streamingGet(name: String, namespace: Option[K8sNamespace], pipeline: ZPipeline[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 parameters

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

Attributes

Returns

A stream of the subresource type

Generated with