trait Service extends ClusterResource[Namespace] with ClusterResourceDelete[Namespace, Status] with ClusterResourceStatus[NamespaceStatus, Namespace] with ClusterFinalizeSubresource[Namespace]
- Alphabetic
- By Inheritance
- Service
- ClusterFinalizeSubresource
- ClusterResourceStatus
- ClusterResourceDelete
- ClusterResource
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
val
asGenericFinalizeSubresource: Subresource[Namespace]
- Definition Classes
- ClusterFinalizeSubresource
-
abstract
val
asGenericResource: Resource[Namespace]
A more generic interface for the same resource
A more generic interface for the same resource
- Definition Classes
- ClusterResource
-
abstract
val
asGenericResourceDelete: ResourceDelete[Namespace, Status]
- Definition Classes
- ClusterResourceDelete
-
abstract
val
asGenericResourceStatus: ResourceStatus[NamespaceStatus, Namespace]
A more generic interface for the same resource
A more generic interface for the same resource
- Definition Classes
- ClusterResourceStatus
Concrete Value Members
- val asGeneric: ZEnvironment[Generic]
-
def
create(newResource: Namespace, dryRun: Boolean = false): IO[K8sFailure, Namespace]
Creates a new resource
Creates a new resource
- newResource
The new resource to define in the cluster.
- 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
- Definition Classes
- ClusterResource
-
def
delete(name: String, deleteOptions: DeleteOptions, dryRun: Boolean = false, gracePeriod: Option[zio.Duration] = None, propagationPolicy: Option[PropagationPolicy] = None): IO[K8sFailure, Status]
Deletes an existing resource selected by its name
Deletes an existing resource selected by its name
- name
Name of the resource
- deleteOptions
Delete options
- 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
- Definition Classes
- ClusterResourceDelete
-
def
deleteAndWait(name: String, deleteOptions: DeleteOptions, dryRun: Boolean = false, gracePeriod: Option[zio.Duration] = None, propagationPolicy: Option[PropagationPolicy] = None)(implicit ev: <:<[Status, Status]): ZIO[Any, K8sFailure, Unit]
Deletes an existing resource selected by its name and waits until it has gone
Deletes an existing resource selected by its name and waits until it has gone
- name
Name of the resource
- deleteOptions
Delete options
- 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.
- Definition Classes
- ClusterResourceDelete
-
def
get(name: String): IO[K8sFailure, Namespace]
Get a resource by its name
Get a resource by its name
- name
Name of the resource
- returns
Returns the current version of the resource
- Definition Classes
- ClusterResource
-
def
getAll(chunkSize: Int = 10, fieldSelector: Option[FieldSelector] = None, labelSelector: Option[LabelSelector] = None, resourceVersion: ListResourceVersion = ListResourceVersion.MostRecent): Stream[K8sFailure, Namespace]
A paginated query of all resources with filtering possibilities
A paginated query of all resources with filtering possibilities
- 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
- Definition Classes
- ClusterResource
-
def
getStatus(name: String): IO[K8sFailure, Namespace]
Get the status of a given subresource by name
Get the status of a given subresource by name
- name
Name of the resource
- returns
Returns the full resource object but with possibly the non-status fields absent.
- Definition Classes
- ClusterResourceStatus
-
def
replace(name: String, updatedResource: Namespace, dryRun: Boolean = false): IO[K8sFailure, Namespace]
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
- 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
- Definition Classes
- ClusterResource
-
def
replaceFinalize(name: String, updatedValue: Namespace, dryRun: Boolean = false): IO[K8sFailure, Namespace]
- Definition Classes
- ClusterFinalizeSubresource
-
def
replaceStatus(of: Namespace, updatedStatus: NamespaceStatus, dryRun: Boolean = false): IO[K8sFailure, Namespace]
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 ClusterResource.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
- 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)
- Definition Classes
- ClusterResourceStatus
-
def
watch(resourceVersion: Option[String], fieldSelector: Option[FieldSelector] = None, labelSelector: Option[LabelSelector] = None, sendInitialEvents: Boolean = false, readTimeout: zio.Duration = Duration.Infinity): Stream[K8sFailure, TypedWatchEvent[Namespace]]
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.
- 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
- Definition Classes
- ClusterResource
-
def
watchForever(resourceVersion: Option[String] = None, fieldSelector: Option[FieldSelector] = None, labelSelector: Option[LabelSelector] = None, sendInitialEvents: Boolean = false, readTimeout: zio.Duration = Duration.Infinity): ZStream[Any, K8sFailure, TypedWatchEvent[Namespace]]
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.
- 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
- Definition Classes
- ClusterResource