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

Secret

com.coralogix.zio.k8s.model.core.v1.Secret
See theSecret companion object
case class Secret(data: Optional[Map[String, Chunk[Byte]]], immutable: Optional[Boolean], metadata: Optional[ObjectMeta], stringData: Optional[Map[String, String]], `type`: Optional[String])

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

Value parameters

data

Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

immutable

Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

stringData

stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API.

type

Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

Attributes

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

Members list

Value members

Concrete methods

def getData: IO[K8sFailure, Map[String, Chunk[Byte]]]

Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Attributes

def getImmutable: IO[K8sFailure, Boolean]

Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Attributes

def getMetadata: IO[K8sFailure, ObjectMeta]

Gets metadata.

Gets metadata.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Attributes

def getStringData: IO[K8sFailure, Map[String, String]]

stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API.

stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Attributes

def getType: IO[K8sFailure, String]

Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Attributes

Inherited methods

def attachOwner(ownerName: String, ownerUid: String, ownerType: K8sResourceType, kind: String): T
Implicitly added by Ops

Attach another resource as the owner of this one

Attach another resource as the owner of this one

Value parameters

kind

Owner's resource kind

ownerName

Owner's name

ownerType

Owner's resource type metadata

ownerUid

Owner's UID

Attributes

Returns

Object with the attached owner described in its metadata

Inherited from:
K8sObjectOps
def generation: Long
Implicitly added by Ops

Gets the geneation of the object or 0 if it is new

Gets the geneation of the object or 0 if it is new

Attributes

Inherited from:
K8sObjectOps
def getMetadata: IO[K8sFailure, ObjectMeta]
Implicitly added by Ops

Gets the metadata of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Gets the metadata of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Attributes

Inherited from:
K8sObjectOps
def getName: IO[K8sFailure, String]
Implicitly added by Ops

Gets the name of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Gets the name of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Attributes

Inherited from:
K8sObjectOps
def getUid: IO[K8sFailure, String]
Implicitly added by Ops

Gets the UID of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Gets the UID of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Attributes

Inherited from:
K8sObjectOps
def isOwnedBy[OwnerT : ResourceMetadata](owner: OwnerT): Boolean
Implicitly added by Ops

Verifies ownership between the resources

Verifies ownership between the resources

Type parameters

OwnerT

Type of the owner resource

Value parameters

owner

Possible owner of this resource

Attributes

Returns

True if owner owns this resource

Inherited from:
K8sObjectOps
def mapMetadata(f: ObjectMeta => ObjectMeta): T
Implicitly added by Ops

Creates a new object with its metadata modified by the given function f

Creates a new object with its metadata modified by the given function f

Value parameters

f

Function to modify the object's metadata with

Attributes

Returns

Object with modified metadata

Inherited from:
K8sObjectOps
def metadata: Optional[ObjectMeta]
Implicitly added by Ops

Gets the metadata of the object

Gets the metadata of the object

Attributes

Inherited from:
K8sObjectOps
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def tryAttachOwner[OwnerT : ResourceMetadata](owner: OwnerT): IO[K8sFailure, T]
Implicitly added by Ops

Tries to attach another resource as the owner of this one. Can fail with com.coralogix.zio.k8s.client.UndefinedField if the owner does not have all the required metadata.

Tries to attach another resource as the owner of this one. Can fail with com.coralogix.zio.k8s.client.UndefinedField if the owner does not have all the required metadata.

Type parameters

OwnerT

Type of the owner

Value parameters

owner

Owner resource

Attributes

Returns

Object with the attached owner described in its metadata

Inherited from:
K8sObjectOps

Concrete fields

override protected val impl: K8sObject[Secret]
Implicitly added by Ops
protected val obj: Secret
Implicitly added by Ops
Generated with