case class ObjectMeta(annotations: Optional[Map[String, String]] = Optional.Absent, clusterName: Optional[String] = Optional.Absent, creationTimestamp: Optional[Time] = Optional.Absent, deletionGracePeriodSeconds: Optional[Long] = Optional.Absent, deletionTimestamp: Optional[Time] = Optional.Absent, finalizers: Optional[Vector[String]] = Optional.Absent, generateName: Optional[String] = Optional.Absent, generation: Optional[Long] = Optional.Absent, labels: Optional[Map[String, String]] = Optional.Absent, managedFields: Optional[Vector[ManagedFieldsEntry]] = Optional.Absent, name: Optional[String] = Optional.Absent, namespace: Optional[String] = Optional.Absent, ownerReferences: Optional[Vector[OwnerReference]] = Optional.Absent, resourceVersion: Optional[String] = Optional.Absent, selfLink: Optional[String] = Optional.Absent, uid: Optional[String] = Optional.Absent) extends Product with Serializable

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

clusterName

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

deletionGracePeriodSeconds

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

managedFields

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

namespace

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ObjectMeta
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ObjectMeta(annotations: Optional[Map[String, String]] = Optional.Absent, clusterName: Optional[String] = Optional.Absent, creationTimestamp: Optional[Time] = Optional.Absent, deletionGracePeriodSeconds: Optional[Long] = Optional.Absent, deletionTimestamp: Optional[Time] = Optional.Absent, finalizers: Optional[Vector[String]] = Optional.Absent, generateName: Optional[String] = Optional.Absent, generation: Optional[Long] = Optional.Absent, labels: Optional[Map[String, String]] = Optional.Absent, managedFields: Optional[Vector[ManagedFieldsEntry]] = Optional.Absent, name: Optional[String] = Optional.Absent, namespace: Optional[String] = Optional.Absent, ownerReferences: Optional[Vector[OwnerReference]] = Optional.Absent, resourceVersion: Optional[String] = Optional.Absent, selfLink: Optional[String] = Optional.Absent, uid: Optional[String] = Optional.Absent)

    annotations

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

    clusterName

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    deletionGracePeriodSeconds

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

    finalizers

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

    generateName

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

    generation

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

    labels

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

    managedFields

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

    name

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

    namespace

    Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

    ownerReferences

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    resourceVersion

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

    uid

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val annotations: Optional[Map[String, String]]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. val clusterName: Optional[String]
  8. val creationTimestamp: Optional[Time]
  9. val deletionGracePeriodSeconds: Optional[Long]
  10. val deletionTimestamp: Optional[Time]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. val finalizers: Optional[Vector[String]]
  13. val generateName: Optional[String]
  14. val generation: Optional[Long]
  15. def getAnnotations: IO[K8sFailure, Map[String, String]]

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

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

  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def getClusterName: IO[K8sFailure, String]

    The name of the cluster which the object belongs to.

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

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

  18. def getCreationTimestamp: IO[K8sFailure, Time]

    Gets creationTimestamp.

    Gets creationTimestamp.

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

  19. def getDeletionGracePeriodSeconds: IO[K8sFailure, Long]

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system.

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

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

  20. def getDeletionTimestamp: IO[K8sFailure, Time]

    Gets deletionTimestamp.

    Gets deletionTimestamp.

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

  21. def getFinalizers: IO[K8sFailure, Vector[String]]

    Must be empty before the object is deleted from the registry.

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

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

  22. def getGenerateName: IO[K8sFailure, String]

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided.

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

    If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

    Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

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

  23. def getGeneration: IO[K8sFailure, Long]

    A sequence number representing a specific generation of the desired state.

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

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

  24. def getLabels: IO[K8sFailure, Map[String, String]]

    Map of string keys and values that can be used to organize and categorize (scope and select) objects.

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

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

  25. def getManagedFields: IO[K8sFailure, Vector[ManagedFieldsEntry]]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow.

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

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

  26. def getName: IO[K8sFailure, String]

    Name must be unique within a namespace.

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

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

  27. def getNamespace: IO[K8sFailure, String]

    Namespace defines the space within which each name must be unique.

    Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

    Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

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

  28. def getOwnerReferences: IO[K8sFailure, Vector[OwnerReference]]

    List of objects depended by this object.

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

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

  29. def getResourceVersion: IO[K8sFailure, String]

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed.

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

    Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

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

  30. def getSelfLink: IO[K8sFailure, String]

    SelfLink is a URL representing this object.

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

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

  31. def getUid: IO[K8sFailure, String]

    UID is the unique in time and space value for this object.

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

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

  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. val labels: Optional[Map[String, String]]
  34. val managedFields: Optional[Vector[ManagedFieldsEntry]]
  35. val name: Optional[String]
  36. val namespace: Optional[String]
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. val ownerReferences: Optional[Vector[OwnerReference]]
  41. val resourceVersion: Optional[String]
  42. val selfLink: Optional[String]
  43. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  44. val uid: Optional[String]
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped