Resource
Generic interface for working with Kubernetes resources
This interface supports both namespaced and cluster resources. For more type safe variants check NamespacedResource and ClusterResource.
Type parameters
- T
-
Resource type
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
Members list
Value members
Abstract methods
Creates a new resource
Creates a new resource
Value parameters
- 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
Attributes
- Returns
-
Returns the created resource as it was returned from Kubernetes
Get a resource by its name
Get a resource by its name
Value parameters
- name
-
Name of the resource
- namespace
-
Namespace. For namespaced resources it must be Some. For cluster resources, it must be None.
Attributes
- Returns
-
Returns the current version of the resource
A paginated query of all resources with filtering possibilities
A paginated query of all resources with filtering possibilities
Value parameters
- 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.
Attributes
- Returns
-
A stream of resources
Replaces an existing resource selected by its name
Replaces an existing resource selected by its name
Value parameters
- 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
Attributes
- Returns
-
Returns the updated resource as it was returned from Kubernetes
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 parameters
- 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
Attributes
- Returns
-
A stream of watch events
Concrete methods
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 parameters
- 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 to start watch from.
Attributes
- Returns
-
A stream of watch events