TestResourceClient

com.coralogix.zio.k8s.client.test.TestResourceClient

See theTestResourceClient companion object

final class TestResourceClient[T, DeleteResult] extends Resource[T] with ResourceDelete[T, DeleteResult] with ResourceDeleteAll[T]

Implementation of Resource and ResourceDeleteAll to be used from unit tests

Attributes

DeleteResult: Result of the delete operation
T: Resource type
events: Watch event queue
store: Object store
Companion:: object
Graph
Supertypes: trait ResourceDeleteAll[T]
trait ResourceDelete[T, DeleteResult]
trait Resource[T]
class Object
trait Matchable
class Any

Concise view

Creates a new resource

dryRun: If true, the request is sent to the server but it will not create the resource.
namespace: Namespace. For namespaced resources it must be Some. For cluster resources, it must be None.
newResource: The new resource to define in the cluster
Returns:: Returns the created resource as it was returned from Kubernetes
Definition Classes: Resource

Deletes an existing resource selected by its name

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.
Returns:: Response from the Kubernetes API
Definition Classes: ResourceDelete

Delete all resources matching the provided constraints

deleteOptions: Delete options
dryRun: If true, the request is sent to the server but it will not create the resource.
fieldSelector: Select the items to be deleted by field selectors. Not all fields are supported by the server.
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.
labelSelector: Select the items to be deleted by label selectors.
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.
Returns:: Status returned by the Kubernetes API
Definition Classes: ResourceDeleteAll

Get a resource by its name

name: Name of the resource
namespace: Namespace. For namespaced resources it must be Some. For cluster resources, it must be None.
Returns:: Returns the current version of the resource
Definition Classes: Resource

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.
namespace: Constraint the query to a given namespace. If None, results returned from all namespaces.
resourceVersion: Control the returned resources' version.
Returns:: A stream of resources
Definition Classes: Resource

Replaces an existing resource selected by its name

dryRun: If true, the request is sent to the server but it will not create the resource.
name: Name of the resource
namespace: Namespace. For namespaced resources it must be Some. For cluster resources, it must be None.
updatedResource: The new value of the resource
Returns:: Returns the updated resource as it was returned from Kubernetes
Definition Classes: Resource

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.

fieldSelector: Constrain the returned items by field selectors. Not all fields are supported by the server.
labelSelector: Constrain the returned items by label selectors.
namespace: Constraint the watched resources by their namespace. If None, all namespaces will be watched.
resourceVersion: Last known resource version
Returns:: A stream of watch events
Definition Classes: Resource

Deletes an existing resource selected by its name and waits until it has gone

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.
Inherited from:: ResourceDelete

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.
namespace: Constraint the watched resources by their namespace. If None, all namespaces will be watched.
Returns:: A stream of watch events
Inherited from:: Resource

Generated with