Service

class Live

Value members

Inherited methods

def create(newResource: ServiceAccount, namespace: K8sNamespace, dryRun: Boolean): IO[K8sFailure, ServiceAccount]

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.

namespace

Namespace of the resource.

newResource

The new resource to define in the cluster.

Returns

Returns the created resource as it was returned from Kubernetes

Inherited from
NamespacedResource
def createToken(name: String, value: TokenRequest, namespace: K8sNamespace, dryRun: Boolean): IO[K8sFailure, TokenRequest]
def delete(name: String, deleteOptions: DeleteOptions, namespace: K8sNamespace, dryRun: Boolean, gracePeriod: Option[Duration], propagationPolicy: Option[PropagationPolicy]): IO[K8sFailure, Status]

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

namespace

Namespace 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
NamespacedResource
def deleteAll(deleteOptions: DeleteOptions, namespace: K8sNamespace, dryRun: Boolean, gracePeriod: Option[Duration], propagationPolicy: Option[PropagationPolicy], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector]): IO[K8sFailure, Status]

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.

namespace

Namespace of the resources to be deleted

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

namespace

Namespace 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
NamespacedResource
def get(name: String, namespace: K8sNamespace): IO[K8sFailure, ServiceAccount]

Get a resource by its name

Get a resource by its name

Value Params
name

Name of the resource

namespace

Namespace of the resource

Returns

Returns the current version of the resource

Inherited from
NamespacedResource
def getAll(namespace: Option[K8sNamespace], chunkSize: Int, fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector], resourceVersion: ListResourceVersion): Stream[K8sFailure, ServiceAccount]

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.

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

Inherited from
NamespacedResource
def replace(name: String, updatedResource: ServiceAccount, namespace: K8sNamespace, dryRun: Boolean): IO[K8sFailure, ServiceAccount]

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

namespace

Namespace of the resource

updatedResource

The new value of the resource

Returns

Returns the updated resource as it was returned from Kubernetes

Inherited from
NamespacedResource
def watch(namespace: Option[K8sNamespace], resourceVersion: Option[String], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector]): Stream[K8sFailure, TypedWatchEvent[ServiceAccount]]

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.

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

Inherited from
NamespacedResource
def watchForever(namespace: Option[K8sNamespace], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector]): ZStream[Clock, K8sFailure, TypedWatchEvent[ServiceAccount]]

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.

namespace

Constraint the watched resources by their namespace. If None, all namespaces will be watched.

Returns

A stream of watch events

Inherited from
NamespacedResource

Concrete fields

Inherited fields

A more generic interface for the same resource

A more generic interface for the same resource

Inherited from
NamespacedResource

A more generic interface for the same resource

A more generic interface for the same resource

Inherited from
NamespacedResourceDeleteAll