com.coralogix.zio.k8s.client.model

Type members

Classlikes

final case
class Added[T](item: T)(implicit evidence$1: K8sObject[T]) extends TypedWatchEvent[T]

Resource added

Resource added

Type Params
T

Watched resource type

Value Params
item

new object that has been added

final case
class Deleted[T](item: T)(implicit evidence$3: K8sObject[T]) extends TypedWatchEvent[T]

Resource has been deleted

Resource has been deleted

Type Params
T

Watched resource type

Value Params
item

the deleted object

sealed

A composable field selector

A composable field selector

Every Kubernetes model's companion object contain a set of Field definitions. To construct FieldSelector values for queries, use these Field values and the operators defined on them.

Note that a very small subset of the fields is actually usable as field seletors, but there is no compile-time information about which one of them are. For this reason we provide a Field for each available field and it is the developer's responsibility to only use supported fields in field selectors, or handle the errors returned by the Kubernetes server.

Companion
object
Companion
class
case
class K8sCluster(host: Uri, applyToken: Option[RequestT[Empty, Either[String, String], Any] => RequestT[Empty, Either[String, String], Any]])

Data type describing a configured Kuberntes cluster

Data type describing a configured Kuberntes cluster

Value Params
applyToken

Function to apply an authentication token to the HTTP request

host

Host to connect to

final case
class K8sCreatorUri(resource: K8sResourceType, namespace: Option[K8sNamespace], dryRun: Boolean) extends K8sUri
final case
class K8sDeletingManyUri(resource: K8sResourceType, namespace: Option[K8sNamespace], dryRun: Boolean, gracePeriod: Option[Duration], propagationPolicy: Option[PropagationPolicy], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector]) extends K8sUri
final case
class K8sDeletingUri(resource: K8sResourceType, name: String, subresource: Option[String], namespace: Option[K8sNamespace], dryRun: Boolean, gracePeriod: Option[Duration], propagationPolicy: Option[PropagationPolicy]) extends K8sUri
final case
class K8sModifierUri(resource: K8sResourceType, name: String, subresource: Option[String], namespace: Option[K8sNamespace], dryRun: Boolean) extends K8sUri
final case
class K8sNamespace(value: String) extends AnyVal

A Kubernetes namespace

A Kubernetes namespace

Companion
object
Companion
class
trait K8sObject[T]

Common operations for every Kubernetes resource's object

Common operations for every Kubernetes resource's object

Type Params
T

Kubernetes resource type

Companion
object
object K8sObject
Companion
class
trait K8sObjectOps[T]

Extension methods for Kubernetes resources

Extension methods for Kubernetes resources

This is a common implementation for all the implicit classes providing extension methods for the generated Kuberentes model types. The extension methods are just delegating the calls to the resource's K8sObject implementation.

Type Params
T

Resource type to be extended

trait K8sObjectStatus[ResourceT, StatusT]

Common operations for every Kubernetes resource type supporting status subresources.

Common operations for every Kubernetes resource type supporting status subresources.

Type Params
ResourceT

Resource type

StatusT

Subresource type

Companion
object
Companion
class
trait K8sObjectStatusOps[ResourceT, StatusT]

Extension methods for Kubernetes resources with status subresource support

Extension methods for Kubernetes resources with status subresource support

This is a common implementation for all the implicit classes providing extension methods for the generated Kuberentes model types. The extension methods are just delegating the calls to the resource's K8sObjectStatus implementation.

Type Params
ResourceT

Resource type to be extended

StatusT

Status subresource type

final case
class K8sPaginatedUri(resource: K8sResourceType, namespace: Option[K8sNamespace], limit: Int, continueToken: Option[String], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector], resourceVersion: ListResourceVersion) extends K8sUri
case
class K8sResourceType(resourceType: String, group: String, version: String)

Metadata identifying a Kubernetes resource

Metadata identifying a Kubernetes resource

Value Params
group

Group

resourceType

Resource type (kind)

version

Version

final case
class K8sSimpleUri(resource: K8sResourceType, name: Option[String], subresource: Option[String], namespace: Option[K8sNamespace]) extends K8sUri
sealed
trait K8sUri

Kubernetes API URI

Kubernetes API URI

final case
class K8sWatchUri(resource: K8sResourceType, namespace: Option[K8sNamespace], resourceVersion: Option[String], allowBookmarks: Boolean, fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector]) extends K8sUri
sealed

Composable label selector

Composable label selector

Use the label constructor LabelSelector.Syntax.label imported through the com.coralogix.zio.k8s.client.model to define labels, and the operators defined on them to construct label selectors from them.

Companion
object
Companion
class
sealed

Resource version options for listing resource

Companion
class
final case
class Modified[T](item: T)(implicit evidence$2: K8sObject[T]) extends TypedWatchEvent[T]

Existing resource modified

Existing resource modified

Type Params
T

Watched resource type

Value Params
item

the modified object

case
class ObjectList[+T](metadata: Optional[ListMeta], items: List[T])

Response type of the getAll operation

Response type of the getAll operation

Type Params
T

Resource type

Value Params
items

Items

metadata

List metadata with continuation token

Companion
object
object ObjectList
Companion
class
sealed
trait Optional[+A]

Custom option type used in the generated Kubernetes data models.

Custom option type used in the generated Kubernetes data models.

Instances of Optional are either Optional.Present or Optional.Absent.

The only difference between this type and scala.Option is that there is an implicit conversion defined from A`` toOptional[A], and fromOption[A]`` to Optional[A].

This allows boilerplate-free definition of Kubernetes resources where most of the fields are optional.

Companion
object
object Optional
Companion
class
final case
class ParsedBookmark[T](resourceVersion: String) extends ParsedWatchEvent[T]

Bookmark event

Bookmark event

Value Params
resourceVersion

Resource version to bookmark

final case

Parsed typed watch event

Parsed typed watch event

Type Params
T

Payload type

Value Params
event

Payload

sealed

Watch event with parsed payload

Watch event with parsed payload

This type is used internally by the watch stream. End users should use the TypedWatchEvent type instead, which does not contain the bookmark event which is transparently handled by the client.

Type Params
T

Payload type

Companion
object
Companion
class
sealed

Propagation policy for resource deletion

Companion
class
case
class Reseted[T]() extends TypedWatchEvent[T]

Watch stream reseted

Watch stream reseted

Resource metadata typeclass

Resource metadata typeclass

Type Params
T

Resource type

sealed

Watch events with decoded payload

Watch events with decoded payload

Type Params
T

Watched resource type

Inherited classlikes

trait Field
Inherited from
Syntax
trait Label
Inherited from
Syntax

Value members

Inherited methods

def field(raw: String): Field

Field constructor, used by the generated companion objects

Field constructor, used by the generated companion objects

Inherited from
Syntax
def field(path: Chunk[String]): Field

Field constructor, used by the generated companion objects

Field constructor, used by the generated companion objects

Inherited from
Syntax
def label(label: String): Label

Defines a label

Defines a label

Inherited from
Syntax

Concrete fields

val k8sDateTimeFormatter: DateTimeFormatter