object namespaced
Generic resource accessor functions for namespaced resources
- Alphabetic
- By Inheritance
- namespaced
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
def
create[T](newResource: T, namespace: K8sNamespace, dryRun: Boolean = false)(implicit arg0: zio.EnvironmentTag[T]): ZIO[NamespacedResource[T], K8sFailure, T]
Creates a new resource
Creates a new resource
- newResource
The new resource to define in the cluster.
- namespace
Namespace of the resource.
- dryRun
If true, the request is sent to the server but it will not create the resource.
- returns
Returns the created resource as it was returned from Kubernetes
-
def
delete[T, DeleteResult](name: String, deleteOptions: DeleteOptions, namespace: K8sNamespace, dryRun: Boolean = false, gracePeriod: Option[zio.Duration] = None, propagationPolicy: Option[PropagationPolicy] = None)(implicit arg0: zio.EnvironmentTag[T], arg1: zio.EnvironmentTag[DeleteResult]): ZIO[NamespacedResourceDelete[T, DeleteResult], K8sFailure, DeleteResult]
Deletes an existing resource selected by its name
Deletes an existing resource selected by its name
- name
Name of the resource
- deleteOptions
Delete options
- namespace
Namespace of the resource
- dryRun
If true, the request is sent to the server but it will not create the resource.
- gracePeriod
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
- propagationPolicy
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
- returns
Response from the Kubernetes API
-
def
deleteAll[T](deleteOptions: DeleteOptions, namespace: K8sNamespace, dryRun: Boolean = false, gracePeriod: Option[zio.Duration] = None, propagationPolicy: Option[PropagationPolicy] = None, fieldSelector: Option[FieldSelector] = None, labelSelector: Option[LabelSelector] = None)(implicit arg0: zio.EnvironmentTag[T]): ZIO[NamespacedResourceDeleteAll[T], K8sFailure, Status]
Delete all resources matching the provided constraints
Delete all resources matching the provided constraints
- deleteOptions
Delete options
- namespace
Namespace of the resources to be deleted
- dryRun
If true, the request is sent to the server but it will not create the resource.
- gracePeriod
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
- propagationPolicy
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
- fieldSelector
Select the items to be deleted by field selectors. Not all fields are supported by the server.
- labelSelector
Select the items to be deleted by label selectors.
- returns
Status returned by the Kubernetes API
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
get[T](name: String, namespace: K8sNamespace)(implicit arg0: zio.EnvironmentTag[T]): ZIO[NamespacedResource[T], K8sFailure, T]
Get a resource by its name
Get a resource by its name
- name
Name of the resource
- namespace
Namespace of the resource
- returns
Returns the current version of the resource
-
def
getAll[T](namespace: Option[K8sNamespace], chunkSize: Int = 10, fieldSelector: Option[FieldSelector] = None, labelSelector: Option[LabelSelector] = None, resourceVersion: ListResourceVersion = ListResourceVersion.MostRecent)(implicit arg0: zio.EnvironmentTag[T]): ZStream[NamespacedResource[T], K8sFailure, T]
A paginated query of all resources with filtering possibilities
A paginated query of all resources with filtering possibilities
- namespace
Constraint the query to a given namespace. If None, results returned from all namespaces.
- chunkSize
Number of items to return per HTTP request
- fieldSelector
Constrain the returned items by field selectors. Not all fields are supported by the server.
- labelSelector
Constrain the returned items by label selectors.
- resourceVersion
Control the returned resources' version.
- returns
A stream of resources
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getStatus[StatusT, T](name: String, namespace: K8sNamespace)(implicit arg0: zio.EnvironmentTag[StatusT], arg1: zio.EnvironmentTag[T]): ZIO[NamespacedResourceStatus[StatusT, T], K8sFailure, T]
Get the status of a given subresource by name
Get the status of a given subresource by name
- name
Name of the resource
- namespace
Namespace of the resource
- returns
Returns the full resource object but with possibly the non-status fields absent.
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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
replace[T](name: String, updatedResource: T, namespace: K8sNamespace, dryRun: Boolean = false)(implicit arg0: zio.EnvironmentTag[T]): ZIO[NamespacedResource[T], K8sFailure, T]
Replaces an existing resource selected by its name
Replaces an existing resource selected by its name
- name
Name of the resource
- updatedResource
The new value of the resource
- namespace
Namespace of the resource
- dryRun
If true, the request is sent to the server but it will not create the resource.
- returns
Returns the updated resource as it was returned from Kubernetes
-
def
replaceStatus[StatusT, T](of: T, updatedStatus: StatusT, namespace: K8sNamespace, dryRun: Boolean = false)(implicit arg0: zio.EnvironmentTag[StatusT], arg1: zio.EnvironmentTag[T]): ZIO[NamespacedResourceStatus[StatusT, T], K8sFailure, T]
Replaces the status of a resource that was previously get from server.
Replaces the status of a resource that was previously get from server.
Use either getStatus or NamespacedResource.get to retrieve a value of the resource by name, and then call this method to update its status.
- of
The resource object to manipulate
- updatedStatus
Updated status value
- namespace
Namespace of the resource
- dryRun
If true, the request is sent to the server but it will not create the resource.
- returns
Returns the updated resource (not just the status)
-
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
watch[T](namespace: Option[K8sNamespace], resourceVersion: Option[String], fieldSelector: Option[FieldSelector] = None, labelSelector: Option[LabelSelector] = None)(implicit arg0: zio.EnvironmentTag[T]): ZStream[NamespacedResource[T], K8sFailure, TypedWatchEvent[T]]
Watch stream of resource change events of type com.coralogix.zio.k8s.client.model.TypedWatchEvent
Watch stream of resource change events of type com.coralogix.zio.k8s.client.model.TypedWatchEvent
This function requires the user to control the starting resourceVersion and to restart the watch stream when the server closes the connection.
For a more convenient variant check watchForever.
- namespace
Constraint the watched resources by their namespace. If None, all namespaces will be watched.
- resourceVersion
Last known resource version
- fieldSelector
Constrain the returned items by field selectors. Not all fields are supported by the server.
- labelSelector
Constrain the returned items by label selectors.
- returns
A stream of watch events
-
def
watchForever[T](namespace: Option[K8sNamespace], resourceVersion: Option[String] = None, fieldSelector: Option[FieldSelector] = None, labelSelector: Option[LabelSelector] = None)(implicit arg0: zio.EnvironmentTag[T]): ZStream[NamespacedResource[T], K8sFailure, TypedWatchEvent[T]]
Infinite watch stream of resource change events of type com.coralogix.zio.k8s.client.model.TypedWatchEvent
Infinite watch stream of resource change events of type com.coralogix.zio.k8s.client.model.TypedWatchEvent
The underlying implementation takes advantage of Kubernetes watch bookmarks.
- namespace
Constraint the watched resources by their namespace. If None, all namespaces will be watched.
- resourceVersion
Last known resource version
- fieldSelector
Constrain the returned items by field selectors. Not all fields are supported by the server.
- labelSelector
Constrain the returned items by label selectors.
- returns
A stream of watch events
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated