com.coralogix.zio.k8s.client

Generic interface for working with Kubernetes cluster resources.

More type safe than Resource as it does not allow passing a namespace.

Type Params

T: Resource type

Extra capability for ClusterResource interfaces providing deleteAll

It is separated because it is not supported by all resources.

Type Params

T: Resource type

Extra capability for ClusterResource interfaces to manage status subresources

Type Params

StatusT: Status subresource type
T: Resource type

Failed Kubernetes API request

Note that some specific failure types are encoded by their own failure type. See Unauthorized, Gone and NotFound.

Value Params

code: Response status code
status: The Kubernetes com.coralogix.zio.k8s.model.pkg.apis.meta.v1.Status value returned in the failure response

Error indicating that Kubernetes API responded with success, but the response body could not be deserialized to the expected data type.

Value Params

error: The list of deserialization errors

Companion

object

Companion: class

The server returned with HTTP 410 (Gone) which has a specific role in handling watch streams.

Failed HTTP response

Indicates that the response from the Kubernetes API has a non-successful status code and it's body did not contain a com.coralogix.zio.k8s.model.pkg.apis.meta.v1.Status value.

In case the error is a standard Kubernetes error message, the error type will be DecodedFailure.

Note that some specific failure types are encoded by their own failure type. See Unauthorized, Gone and NotFound.

Value Params

code: Response status code
message: Response message

An unsupported event type was sent in a watch stream

Value Params

eventType: The unrecognized event type from the server

Error type of the Kubernetes client

Companion: object

Companion: class

K8s API request information to be provided in K8sFailure failures

Value Params

operation: Operation name
resourceType: Resource type

Generic interface for working with namespaced Kubernetes resources.

More type safe than Resource as it requires passing a namespace where necessary.

Type Params

T: Resource type

Extra capability for NamespacedResource interfaces providing deleteAll

It is separated because it is not supported by all resources.

Type Params

T: Resource type

Extra capability for NamespacedResource interfaces to manage status subresources

Type Params

StatusT: Status subresource type
T: Resource type

The sever returned with HTTP 404 (NotFound).

See the K8sFailure.syntax.K8sZIOSyntax.ifFound extension method for a convenient way to handle these errors.

Failed to send the HTTP request to the Kubernetes API

Value Params

reason: The failure reason

Generic interface for working with Kubernetes resources

This interface supports both namespaced and cluster resources. For more type safe variants check NamespacedResource and ClusterResource.

Type Params

T: Resource type

Extra capability for Resource interfaces providing deleteAll

It is separated because it is not supported by all resources.

Type Params

T: Resource type

Extra capability for Resource interfaces to manage status subresources

Type Params

StatusT: Status subresource type
T: Resource type

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

Request unauthorized

Indicates that the Kubernetes API returned a HTTP 401 response.

Value Params

message: Message of the response

Error produced by the generated getter methods on Kubernetes data structures.

Indicates that the requested field is not present.

Value Params

field: Field name

com.coralogix.zio.k8s.client

Type members

Classlikes