ResourceDelete

com.coralogix.zio.k8s.client.ResourceDelete
trait ResourceDelete[T, DeleteResult]

Extra capability for Resource interfaces providing delete

It is separated because because its result type varies for different resources.

Type parameters

DeleteResult

Delete result type

T

Resource type

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ResourceClient[T, DeleteResult]
class TestResourceClient[T, DeleteResult]

Members list

Value members

Abstract methods

def delete(name: String, deleteOptions: DeleteOptions, namespace: Option[K8sNamespace], dryRun: Boolean, gracePeriod: Option[Duration], propagationPolicy: Option[PropagationPolicy]): IO[K8sFailure, DeleteResult]

Deletes an existing resource selected by its name

Deletes an existing resource selected by its name

Value parameters

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.

name

Name of the resource

namespace

Namespace. For namespaced resources it must be Some. For cluster resources, it must be None.

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.

Attributes

Returns

Response from the Kubernetes API

Concrete methods

def deleteAndWait(name: String, deleteOptions: DeleteOptions, namespace: Option[K8sNamespace], dryRun: Boolean, gracePeriod: Option[Duration], propagationPolicy: Option[PropagationPolicy])(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

Value parameters

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.

name

Name of the resource

namespace

Namespace. For namespaced resources it must be Some. For cluster resources, it must be None.

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.

Attributes