zio-k8s-client
API
Generated with
zio-k8s-client/com.coralogix.zio.k8s/com.coralogix.zio.k8s.client/com.coralogix.zio.k8s.client.model

com.coralogix.zio.k8s.client.model

package com.coralogix.zio.k8s.client.model

Members list

Packages

package com.coralogix.zio.k8s.client.model.codecs
package com.coralogix.zio.k8s.client.model.primitives

Type members

Classlikes

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

Resource added

Resource added

Type parameters

T

Watched resource type

Value parameters

item

new object that has been added

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TypedWatchEvent[T]
class Object
trait Matchable
class Any
Show all
final case class Deleted[T](item: T)(implicit evidence$3: K8sObject[T]) extends TypedWatchEvent[T]

Resource has been deleted

Resource has been deleted

Type parameters

T

Watched resource type

Value parameters

item

the deleted object

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TypedWatchEvent[T]
class Object
trait Matchable
class Any
Show all
sealed trait FieldSelector

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.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class And
class FieldEquals
Self type
object FieldSelector

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
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 parameters

applyToken

Function to apply an authentication token to the HTTP request

host

Host to connect to

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class K8sCreatorUri(resource: K8sResourceType, namespace: Option[K8sNamespace], dryRun: Boolean) extends K8sUri

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sUri
class Object
trait Matchable
class Any
Show all
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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sUri
class Object
trait Matchable
class Any
Show all
final case class K8sDeletingUri(resource: K8sResourceType, name: String, subresource: Option[String], namespace: Option[K8sNamespace], dryRun: Boolean, gracePeriod: Option[Duration], propagationPolicy: Option[PropagationPolicy]) extends K8sUri

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sUri
class Object
trait Matchable
class Any
Show all
final case class K8sModifierUri(resource: K8sResourceType, name: String, subresource: Option[String], namespace: Option[K8sNamespace], dryRun: Boolean) extends K8sUri

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sUri
class Object
trait Matchable
class Any
Show all
final case class K8sNamespace(value: String) extends AnyVal

A Kubernetes namespace

A Kubernetes namespace

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
Show all
object K8sNamespace

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait K8sObject[T]

Common operations for every Kubernetes resource's object

Common operations for every Kubernetes resource's object

Type parameters

T

Kubernetes resource type

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object K8sObject

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
K8sObject.type
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 parameters

T

Resource type to be extended

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Ops[T]
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
class Ops
Show all
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 parameters

ResourceT

Resource type

StatusT

Subresource type

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object K8sObjectStatus

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
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 parameters

ResourceT

Resource type to be extended

StatusT

Status subresource type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class StatusOps[ResourceT, StatusT]
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
class StatusOps
Show all
final case class K8sPaginatedUri(resource: K8sResourceType, namespace: Option[K8sNamespace], limit: Int, continueToken: Option[String], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector], resourceVersion: ListResourceVersion) extends K8sUri

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sUri
class Object
trait Matchable
class Any
Show all
case class K8sResourceType(resourceType: String, group: String, version: String)

Metadata identifying a Kubernetes resource

Metadata identifying a Kubernetes resource

Value parameters

group

Group

resourceType

Resource type (kind)

version

Version

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class K8sSimpleUri(resource: K8sResourceType, name: Option[String], subresource: Option[String], namespace: Option[K8sNamespace]) extends K8sUri

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sUri
class Object
trait Matchable
class Any
Show all
sealed trait K8sUri

Kubernetes API URI

Kubernetes API URI

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class K8sSimpleUri
class K8sWatchUri
Show all
final case class K8sWatchUri(resource: K8sResourceType, namespace: Option[K8sNamespace], resourceVersion: Option[String], allowBookmarks: Boolean, fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector]) extends K8sUri

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sUri
class Object
trait Matchable
class Any
Show all
sealed trait LabelSelector

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.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class And
class LabelEquals
class LabelIn
class LabelNotIn
Self type
object LabelSelector

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait ListResourceVersion

Resource version options for listing resource

Resource version options for listing resource

See https://kubernetes.io/docs/reference/using-api/api-concepts/#the-resourceversion-parameter

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Any.type
class Exact
object MostRecent.type
class NotOlderThan
object ListResourceVersion

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Modified[T](item: T)(implicit evidence$2: K8sObject[T]) extends TypedWatchEvent[T]

Existing resource modified

Existing resource modified

Type parameters

T

Watched resource type

Value parameters

item

the modified object

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TypedWatchEvent[T]
class Object
trait Matchable
class Any
Show all
case class ObjectList[+T](metadata: Optional[ListMeta], items: List[T])

Response type of the getAll operation

Response type of the getAll operation

Type parameters

T

Resource type

Value parameters

items

Items

metadata

List metadata with continuation token

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ObjectList

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ObjectList.type
final case class ParsedBookmark[T](resourceVersion: String) extends ParsedWatchEvent[T]

Bookmark event

Bookmark event

Value parameters

resourceVersion

Resource version to bookmark

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ParsedWatchEvent[T]
class Object
trait Matchable
class Any
Show all
final case class ParsedTypedWatchEvent[T](event: TypedWatchEvent[T]) extends ParsedWatchEvent[T]

Parsed typed watch event

Parsed typed watch event

Type parameters

T

Payload type

Value parameters

event

Payload

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ParsedWatchEvent[T]
class Object
trait Matchable
class Any
Show all
sealed trait ParsedWatchEvent[T]

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 parameters

T

Payload type

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ParsedBookmark[T]
object ParsedWatchEvent

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait PropagationPolicy

Propagation policy for resource deletion

Propagation policy for resource deletion

See https://kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Background.type
object Foreground.type
object Orphan.type
object PropagationPolicy

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Reseted[T]() extends TypedWatchEvent[T]

Watch stream reseted

Watch stream reseted

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TypedWatchEvent[T]
class Object
trait Matchable
class Any
Show all
trait ResourceMetadata[T]

Resource metadata typeclass

Resource metadata typeclass

Type parameters

T

Resource type

Attributes

Supertypes
class Object
trait Matchable
class Any
sealed trait TypedWatchEvent[T]

Watch events with decoded payload

Watch events with decoded payload

Type parameters

T

Watched resource type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Added[T]
class Deleted[T]
class Modified[T]
class Reseted[T]

Inherited classlikes

trait Field

Attributes

Inherited from:
Syntax
Supertypes
class Object
trait Matchable
class Any
trait Label

Attributes

Inherited from:
Syntax
Supertypes
class Object
trait Matchable
class Any

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

Attributes

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

Attributes

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

Defines a label

Defines a label

Attributes

Inherited from:
Syntax

Concrete fields

val k8sDateTimeFormatter: DateTimeFormatter

Implicits

Implicits

implicit def leftOptionalIsOption[T]: IsOption[Either[Optional[T], _]]
implicit def optionalDecoder[A : Decoder]: Decoder[Optional[A]]
implicit def optionalEncoder[A : Encoder]: Encoder[Optional[A]]
implicit def optionalIsOption[T]: IsOption[Optional[T]]
implicit def rightOptionalIsOption[T]: IsOption[Either[_, Optional[T]]]
Generated with