trait K8sObject[T] extends AnyRef

Common operations for every Kubernetes resource's object

T

Kubernetes resource type

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. K8sObject
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def mapMetadata(f: (ObjectMeta) ⇒ ObjectMeta)(r: T): T

    Maps the metadata of the object, constructing a new object with the modified metadata

    Maps the metadata of the object, constructing a new object with the modified metadata

    f

    Function returning the modified metadata

  2. abstract def metadata(obj: T): Optional[ObjectMeta]

    Gets the metadata of the object

Concrete Value Members

  1. def attachOwner(obj: T)(ownerName: String, ownerUid: String, ownerType: K8sResourceType, kind: String): T

    Attach another Kubernetes resource as the owner of the given one

    Attach another Kubernetes resource as the owner of the given one

    obj

    Object to attach the owner to

    ownerName

    Owner's name

    ownerUid

    Owner's UID

    ownerType

    Owner's resource type

    kind

    Owner's resource kind

    returns

    The modified object with the attached owner

  2. def generation(obj: T): Long

    Gets the generation of the object stored in its metadata or 0 if it is not present (the resource was not uploaded yet)

  3. def getMetadata(obj: T): IO[K8sFailure, ObjectMeta]

    Gets the metadata of the object or fails with UndefinedField if it is not present.

  4. def getName(obj: T): IO[K8sFailure, String]

    Gets the name stored in the metadata of the object or fails with UndefinedField if it is not present.

  5. def getUid(obj: T): IO[K8sFailure, String]

    Gets the UID stored in the metadata of the object or fails with UndefinedField if it is not present.

  6. def isOwnedBy[OwnerT](obj: T)(owner: OwnerT)(implicit arg0: K8sObject[OwnerT], arg1: ResourceMetadata[OwnerT]): Boolean

    Check if a resource is owned by an other one

    Check if a resource is owned by an other one

    OwnerT

    Owner resource type

    obj

    Owned resource object to check

    owner

    Owner

    returns

    True if owner owns obj

  7. def tryAttachOwner[OwnerT](obj: T)(owner: OwnerT)(implicit arg0: K8sObject[OwnerT], arg1: ResourceMetadata[OwnerT]): IO[K8sFailure, T]

    Try to attachOwner another Kubernetes resource as the owner of the given one, can fail with UndefinedField if some of the metadata fields are not present.