Packages

c

com.coralogix.zio.k8s.client.impl

SubresourceClient

final class SubresourceClient[T] extends Subresource[T] with ResourceClientBase

Generic implementation for Subresource

T

Subresource type

Linear Supertypes
ResourceClientBase, Subresource[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SubresourceClient
  2. ResourceClientBase
  3. Subresource
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SubresourceClient(resourceType: K8sResourceType, cluster: K8sCluster, backend: SttpBackend[Task, ZioStreams with WebSockets], subresourceName: String)(implicit arg0: Encoder[T], arg1: Decoder[T])

    resourceType

    Kubernetes resource metadata

    cluster

    Configured Kubernetes cluster

    backend

    Configured HTTP client

    subresourceName

    Name of the subresource

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asJsonAccumulating[B](implicit arg0: IsOptional[B]): ResponseAs[Either[ResponseException[String, NonEmptyList[Error]], B], Any]

    If the response is successful (2xx), tries to deserialize the body from a string into JSON.

    If the response is successful (2xx), tries to deserialize the body from a string into JSON. Returns:

    • Right(b) if the parsing was successful
    • Left(HttpError(String)) if the response code was other than 2xx (deserialization is not attempted)
    • Left(DeserializationException) if there's an error during deserialization
    Attributes
    protected
    Definition Classes
    ResourceClientBase
  6. val backend: SttpBackend[Task, ZioStreams with WebSockets]
    Attributes
    protected
    Definition Classes
    SubresourceClient → ResourceClientBase
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. val cluster: K8sCluster
    Attributes
    protected
    Definition Classes
    SubresourceClient → ResourceClientBase
  9. 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

    Definition Classes
    SubresourceClient → Subresource
  10. def creating(namespace: Option[K8sNamespace], dryRun: Boolean): Uri
    Attributes
    protected
    Definition Classes
    ResourceClientBase
  11. def deleting(name: String, subresource: Option[String], namespace: Option[K8sNamespace], dryRun: Boolean, gracePeriod: Option[zio.Duration], propagationPolicy: Option[PropagationPolicy]): Uri
    Attributes
    protected
    Definition Classes
    ResourceClientBase
  12. def deletingMany(namespace: Option[K8sNamespace], dryRun: Boolean, gracePeriod: Option[zio.Duration], propagationPolicy: Option[PropagationPolicy], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector]): Uri
    Attributes
    protected
    Definition Classes
    ResourceClientBase
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. 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

    Definition Classes
    SubresourceClient → Subresource
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def handleFailures[A](operation: String, namespace: Option[K8sNamespace], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector], name: Option[String])(f: Task[Response[Either[ResponseException[String, NonEmptyList[Error]], A]]]): IO[K8sFailure, A]
    Attributes
    protected
    Definition Classes
    ResourceClientBase
  18. def handleFailures[A](operation: String, namespace: Option[K8sNamespace], name: String)(f: Task[Response[Either[ResponseException[String, NonEmptyList[Error]], A]]]): IO[K8sFailure, A]
    Attributes
    protected
    Definition Classes
    ResourceClientBase
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val k8sRequest: RequestT[Empty, Either[String, String], Any]
    Attributes
    protected
    Definition Classes
    ResourceClientBase
  22. def modifying(name: String, subresource: Option[String], namespace: Option[K8sNamespace], dryRun: Boolean): Uri
    Attributes
    protected
    Definition Classes
    ResourceClientBase
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def paginated(namespace: Option[K8sNamespace], limit: Int, continueToken: Option[String], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector], resourceVersion: ListResourceVersion): Uri
    Attributes
    protected
    Definition Classes
    ResourceClientBase
  27. 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

    Definition Classes
    SubresourceClient → Subresource
  28. val resourceType: K8sResourceType
    Attributes
    protected
    Definition Classes
    SubresourceClient → ResourceClientBase
  29. def simple(name: Option[String], subresource: Option[String], namespace: Option[K8sNamespace]): Uri
    Attributes
    protected
    Definition Classes
    ResourceClientBase
  30. def streamingGet(name: String, namespace: Option[K8sNamespace], pipeline: 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.

    customParameters

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

    returns

    A stream of the subresource type

    Definition Classes
    SubresourceClient → Subresource
  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def watching(namespace: Option[K8sNamespace], resourceVersion: Option[String], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector]): Uri
    Attributes
    protected
    Definition Classes
    ResourceClientBase

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from ResourceClientBase

Inherited from Subresource[T]

Inherited from AnyRef

Inherited from Any

Ungrouped