final class SubresourceClient[T] extends Subresource[T] with ResourceClientBase
- Alphabetic
- By Inheritance
- SubresourceClient
- ResourceClientBase
- Subresource
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
SubresourceClient(resourceType: K8sResourceType, cluster: K8sCluster, backend: K8sBackend, 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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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 successfulLeft(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
-
val
backend: K8sBackend
- Attributes
- protected
- Definition Classes
- SubresourceClient → ResourceClientBase
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
val
cluster: K8sCluster
- Attributes
- protected
- Definition Classes
- SubresourceClient → ResourceClientBase
-
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
-
def
creating(namespace: Option[K8sNamespace], dryRun: Boolean): Uri
- Attributes
- protected
- Definition Classes
- ResourceClientBase
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
-
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
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
val
k8sRequest: RequestT[Empty, Either[String, String], Any]
- Attributes
- protected
- Definition Classes
- ResourceClientBase
-
def
modifying(name: String, subresource: Option[String], namespace: Option[K8sNamespace], dryRun: Boolean): Uri
- Attributes
- protected
- Definition Classes
- ResourceClientBase
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
paginated(namespace: Option[K8sNamespace], limit: Int, continueToken: Option[String], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector], resourceVersion: ListResourceVersion): Uri
- Attributes
- protected
- Definition Classes
- ResourceClientBase
-
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
-
val
resourceType: K8sResourceType
- Attributes
- protected
- Definition Classes
- SubresourceClient → ResourceClientBase
-
def
simple(name: Option[String], subresource: Option[String], namespace: Option[K8sNamespace]): Uri
- Attributes
- protected
- Definition Classes
- ResourceClientBase
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
watching(namespace: Option[K8sNamespace], resourceVersion: Option[String], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector], sendInitialEvents: Boolean): Uri
- Attributes
- protected
- Definition Classes
- ResourceClientBase
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated