Packages

package client

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. trait ClusterResource[T] extends AnyRef

    Generic interface for working with Kubernetes cluster resources.

    Generic interface for working with Kubernetes cluster resources.

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

    T

    Resource type

  2. trait ClusterResourceDelete[T, DeleteResult] extends AnyRef
  3. trait ClusterResourceDeleteAll[T] extends AnyRef

    Extra capability for ClusterResource interfaces providing deleteAll

    Extra capability for ClusterResource interfaces providing deleteAll

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

    T

    Resource type

  4. trait ClusterResourceStatus[StatusT, T] extends AnyRef

    Extra capability for ClusterResource interfaces to manage status subresources

    Extra capability for ClusterResource interfaces to manage status subresources

    StatusT

    Status subresource type

    T

    Resource type

  5. final case class CodingFailure(requestInfo: K8sRequestInfo, failure: CharacterCodingException) extends K8sFailure with Product with Serializable

    Error in the UTF-8 character coding of the response from the Kubernetes API

    Error in the UTF-8 character coding of the response from the Kubernetes API

    failure

    The character coding error

  6. final case class DecodedFailure(requestInfo: K8sRequestInfo, status: Status, code: StatusCode) extends K8sFailure with Product with Serializable

    Failed Kubernetes API request

    Failed Kubernetes API request

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

    status

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

    code

    Response status code

  7. final case class DeserializationFailure(requestInfo: K8sRequestInfo, error: NonEmptyList[Error]) extends K8sFailure with Product with Serializable

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

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

    error

    The list of deserialization errors

  8. final case class ErrorEvent(status: String, message: String, reason: String, code: Int) extends K8sFailure with Product with Serializable
  9. final case class HttpFailure(requestInfo: K8sRequestInfo, message: String, code: StatusCode) extends K8sFailure with Product with Serializable

    Failed HTTP response

    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.

    message

    Response message

    code

    Response status code

  10. final case class InvalidEvent(requestInfo: K8sRequestInfo, eventType: String) extends K8sFailure with Product with Serializable

    An unsupported event type was sent in a watch stream

    An unsupported event type was sent in a watch stream

    eventType

    The unrecognized event type from the server

  11. sealed trait K8sFailure extends AnyRef

    Error type of the Kubernetes client

  12. case class K8sRequestInfo(resourceType: K8sResourceType, operation: String, namespace: Option[K8sNamespace], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector], name: Option[String]) extends Product with Serializable

    K8s API request information to be provided in K8sFailure failures

    K8s API request information to be provided in K8sFailure failures

    resourceType

    Resource type

    operation

    Operation name

  13. trait NamespacedResource[T] extends AnyRef

    Generic interface for working with namespaced Kubernetes resources.

    Generic interface for working with namespaced Kubernetes resources.

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

    T

    Resource type

  14. trait NamespacedResourceDelete[T, DeleteResult] extends AnyRef
  15. trait NamespacedResourceDeleteAll[T] extends AnyRef

    Extra capability for NamespacedResource interfaces providing deleteAll

    Extra capability for NamespacedResource interfaces providing deleteAll

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

    T

    Resource type

  16. trait NamespacedResourceStatus[StatusT, T] extends AnyRef

    Extra capability for NamespacedResource interfaces to manage status subresources

    Extra capability for NamespacedResource interfaces to manage status subresources

    StatusT

    Status subresource type

    T

    Resource type

  17. final case class RequestFailure(requestInfo: K8sRequestInfo, reason: Throwable) extends K8sFailure with Product with Serializable

    Failed to send the HTTP request to the Kubernetes API

    Failed to send the HTTP request to the Kubernetes API

    reason

    The failure reason

  18. trait Resource[T] extends AnyRef

    Generic interface for working with Kubernetes resources

    Generic interface for working with Kubernetes resources

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

    T

    Resource type

  19. trait ResourceDelete[T, DeleteResult] extends AnyRef

    Extra capability for Resource interfaces providing delete

    Extra capability for Resource interfaces providing delete

    It is separated because because its result type varies for different resources.

    T

    Resource type

    DeleteResult

    Delete result type

  20. trait ResourceDeleteAll[T] extends AnyRef

    Extra capability for Resource interfaces providing deleteAll

    Extra capability for Resource interfaces providing deleteAll

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

    T

    Resource type

  21. trait ResourceStatus[StatusT, T] extends AnyRef

    Extra capability for Resource interfaces to manage status subresources

    Extra capability for Resource interfaces to manage status subresources

    StatusT

    Status subresource type

    T

    Resource type

  22. trait Subresource[T] extends AnyRef

    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.

    T

    Subresource type

  23. final case class Unauthorized(requestInfo: K8sRequestInfo, message: String) extends K8sFailure with Product with Serializable

    Request unauthorized

    Request unauthorized

    Indicates that the Kubernetes API returned a HTTP 401 response.

    message

    Message of the response

  24. final case class UndefinedField(field: String) extends K8sFailure with Product with Serializable

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

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

    Indicates that the requested field is not present.

    field

    Field name

Value Members

  1. object DeserializationFailure extends Serializable
  2. object ErrorEvent extends Serializable
  3. object Gone extends K8sFailure with Product with Serializable

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

  4. object K8sFailure
  5. object K8sRequestInfo extends Serializable
  6. object NotFound extends K8sFailure with Product with Serializable

    The sever returned with HTTP 404 (NotFound).

    The sever returned with HTTP 404 (NotFound).

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

Ungrouped