trait ResourceDelete[T, DeleteResult] extends AnyRef
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
- Alphabetic
- By Inheritance
- ResourceDelete
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
delete(name: String, deleteOptions: DeleteOptions, namespace: Option[K8sNamespace], dryRun: Boolean = false, gracePeriod: Option[zio.Duration] = None, propagationPolicy: Option[PropagationPolicy] = None): IO[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. 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.
- 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
Concrete Value Members
-
def
deleteAndWait(name: String, deleteOptions: DeleteOptions, namespace: Option[K8sNamespace], dryRun: Boolean = false, gracePeriod: Option[zio.Duration] = None, propagationPolicy: Option[PropagationPolicy] = None)(implicit ev: <:<[DeleteResult, 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
- 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.
- 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.