Service
Value members
Inherited methods
Creates a new resource
Creates a new resource
- Value Params
- dryRun
If true, the request is sent to the server but it will not create the resource.
- newResource
The new resource to define in the cluster.
- Returns
Returns the created resource as it was returned from Kubernetes
- Inherited from
- ClusterResource
Deletes an existing resource selected by its name
Deletes an existing resource selected by its name
- Value Params
- 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
- 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
- Inherited from
- ClusterResource
Delete all resources matching the provided constraints
Delete all resources matching the provided constraints
- Value Params
- 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.
- 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
- Inherited from
- ClusterResourceDeleteAll
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 Params
- 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
- 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
- ClusterResource
Get a resource by its name
Get a resource by its name
- Value Params
- name
Name of the resource
- Returns
Returns the current version of the resource
- Inherited from
- ClusterResource
A paginated query of all resources with filtering possibilities
A paginated query of all resources with filtering possibilities
- Value Params
- 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
- Inherited from
- ClusterResource
Get the status of a given subresource by name
Get the status of a given subresource by name
- Value Params
- name
Name of the resource
- Returns
Returns the full resource object but with possibly the non-status fields absent.
- Inherited from
- ClusterResourceStatus
Replaces an existing resource selected by its name
Replaces an existing resource selected by its name
- Value Params
- dryRun
If true, the request is sent to the server but it will not create the resource.
- name
Name of the resource
- updatedResource
The new value of the resource
- Returns
Returns the updated resource as it was returned from Kubernetes
- Inherited from
- ClusterResource
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.
- Value Params
- dryRun
If true, the request is sent to the server but it will not create the resource.
- of
The resource object to manipulate
- updatedStatus
Updated status value
- Returns
Returns the updated resource (not just the status)
- Inherited from
- ClusterResourceStatus
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.
- Value Params
- 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
Last known resource version
- Returns
A stream of watch events
- Inherited from
- ClusterResource
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.
- Value Params
- 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
- Inherited from
- ClusterResource
Inherited fields
A more generic interface for the same resource
A more generic interface for the same resource
- Inherited from
- ClusterResource
A more generic interface for the same resource
A more generic interface for the same resource
- Inherited from
- ClusterResourceDeleteAll
A more generic interface for the same resource
A more generic interface for the same resource
- Inherited from
- ClusterResourceStatus