Package com.marcnuri.yakc.model.io.k8s.apimachinery.pkg.apis.meta.v1

Class ObjectMeta

  • All Implemented Interfaces:
    com.marcnuri.yakc.model.Model
    public class ObjectMeta
extends java.lang.Object
implements com.marcnuri.yakc.model.Model
    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ObjectMeta.Builder  

    • Constructor Summary

      Constructors 
      Constructor Description
      ObjectMeta()  
      ObjectMeta​(java.util.Map<java.lang.String,​java.lang.String> annotations, java.lang.String clusterName, java.time.OffsetDateTime creationTimestamp, java.lang.Number deletionGracePeriodSeconds, java.time.OffsetDateTime deletionTimestamp, java.util.List<java.lang.String> finalizers, java.lang.String generateName, java.lang.Number generation, java.util.Map<java.lang.String,​java.lang.String> labels, java.util.List<ManagedFieldsEntry> managedFields, java.lang.String name, java.lang.String namespace, java.util.List<OwnerReference> ownerReferences, java.lang.String resourceVersion, java.lang.String selfLink, java.lang.String uid)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ObjectMeta.Builder builder()  
      protected boolean canEqual​(java.lang.Object other)  
      boolean equals​(java.lang.Object o)  
      java.util.Map<java.lang.String,​java.lang.String> getAnnotations()
      Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
      java.lang.String getClusterName()
      The name of the cluster which the object belongs to.
      java.time.OffsetDateTime getCreationTimestamp()  
      java.lang.Number getDeletionGracePeriodSeconds()
      Number of seconds allowed for this object to gracefully terminate before it will be removed from the system.
      java.time.OffsetDateTime getDeletionTimestamp()  
      java.util.List<java.lang.String> getFinalizers()
      Must be empty before the object is deleted from the registry.
      java.lang.String getGenerateName()
      GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided.
      java.lang.Number getGeneration()
      A sequence number representing a specific generation of the desired state.
      java.util.Map<java.lang.String,​java.lang.String> getLabels()
      Map of string keys and values that can be used to organize and categorize (scope and select) objects.
      java.util.List<ManagedFieldsEntry> getManagedFields()
      ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow.
      java.lang.String getName()
      Name must be unique within a namespace.
      java.lang.String getNamespace()
      Namespace defines the space within which each name must be unique.
      java.util.List<OwnerReference> getOwnerReferences()
      List of objects depended by this object.
      java.lang.String getResourceVersion()
      An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed.
      java.lang.String getSelfLink()
      SelfLink is a URL representing this object.
      java.lang.String getUid()
      UID is the unique in time and space value for this object.
      int hashCode()  
      void setAnnotations​(java.util.Map<java.lang.String,​java.lang.String> 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.
      void setClusterName​(java.lang.String clusterName)
      The name of the cluster which the object belongs to.
      void setCreationTimestamp​(java.time.OffsetDateTime creationTimestamp)  
      void setDeletionGracePeriodSeconds​(java.lang.Number deletionGracePeriodSeconds)
      Number of seconds allowed for this object to gracefully terminate before it will be removed from the system.
      void setDeletionTimestamp​(java.time.OffsetDateTime deletionTimestamp)  
      void setFinalizers​(java.util.List<java.lang.String> finalizers)
      Must be empty before the object is deleted from the registry.
      void setGenerateName​(java.lang.String generateName)
      GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided.
      void setGeneration​(java.lang.Number generation)
      A sequence number representing a specific generation of the desired state.
      void setLabels​(java.util.Map<java.lang.String,​java.lang.String> labels)
      Map of string keys and values that can be used to organize and categorize (scope and select) objects.
      void setManagedFields​(java.util.List<ManagedFieldsEntry> managedFields)
      ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow.
      void setName​(java.lang.String name)
      Name must be unique within a namespace.
      void setNamespace​(java.lang.String namespace)
      Namespace defines the space within which each name must be unique.
      void setOwnerReferences​(java.util.List<OwnerReference> ownerReferences)
      List of objects depended by this object.
      void setResourceVersion​(java.lang.String resourceVersion)
      An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed.
      void setSelfLink​(java.lang.String selfLink)
      SelfLink is a URL representing this object.
      void setUid​(java.lang.String uid)
      UID is the unique in time and space value for this object.
      ObjectMeta.Builder toBuilder()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • ObjectMeta

        public ObjectMeta​(java.util.Map<java.lang.String,​java.lang.String> annotations,
                  java.lang.String clusterName,
                  java.time.OffsetDateTime creationTimestamp,
                  java.lang.Number deletionGracePeriodSeconds,
                  java.time.OffsetDateTime deletionTimestamp,
                  java.util.List<java.lang.String> finalizers,
                  java.lang.String generateName,
                  java.lang.Number generation,
                  java.util.Map<java.lang.String,​java.lang.String> labels,
                  java.util.List<ManagedFieldsEntry> managedFields,
                  java.lang.String name,
                  java.lang.String namespace,
                  java.util.List<OwnerReference> ownerReferences,
                  java.lang.String resourceVersion,
                  java.lang.String selfLink,
                  java.lang.String uid)

      • ObjectMeta

        public ObjectMeta()

    • Method Detail

      • getAnnotations

        public java.util.Map<java.lang.String,​java.lang.String> getAnnotations()
        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

      • getClusterName

        public java.lang.String getClusterName()
        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.

      • getCreationTimestamp

        public java.time.OffsetDateTime getCreationTimestamp()

      • getDeletionGracePeriodSeconds

        public java.lang.Number getDeletionGracePeriodSeconds()
        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.

      • getDeletionTimestamp

        public java.time.OffsetDateTime getDeletionTimestamp()

      • getFinalizers

        public java.util.List<java.lang.String> getFinalizers()
        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.

      • getGenerateName

        public java.lang.String getGenerateName()
        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

      • getGeneration

        public java.lang.Number getGeneration()
        A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

      • getLabels

        public java.util.Map<java.lang.String,​java.lang.String> getLabels()
        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

      • getManagedFields

        public java.util.List<ManagedFieldsEntry> getManagedFields()
        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.

      • getName

        public java.lang.String getName()
        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

      • getNamespace

        public java.lang.String getNamespace()
        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

      • getOwnerReferences

        public java.util.List<OwnerReference> getOwnerReferences()
        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.

      • getResourceVersion

        public java.lang.String getResourceVersion()
        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

      • getSelfLink

        public java.lang.String getSelfLink()
        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.

      • getUid

        public java.lang.String getUid()
        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

      • setAnnotations

        public void setAnnotations​(java.util.Map<java.lang.String,​java.lang.String> 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

      • setClusterName

        public void setClusterName​(java.lang.String 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.

      • setCreationTimestamp

        public void setCreationTimestamp​(java.time.OffsetDateTime creationTimestamp)

      • setDeletionGracePeriodSeconds

        public void setDeletionGracePeriodSeconds​(java.lang.Number 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.

      • setDeletionTimestamp

        public void setDeletionTimestamp​(java.time.OffsetDateTime deletionTimestamp)

      • setFinalizers

        public void setFinalizers​(java.util.List<java.lang.String> 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.

      • setGenerateName

        public void setGenerateName​(java.lang.String 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

      • setGeneration

        public void setGeneration​(java.lang.Number generation)
        A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

      • setLabels

        public void setLabels​(java.util.Map<java.lang.String,​java.lang.String> 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

      • setManagedFields

        public void setManagedFields​(java.util.List<ManagedFieldsEntry> 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.

      • setName

        public void setName​(java.lang.String 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

      • setNamespace

        public void setNamespace​(java.lang.String 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

      • setOwnerReferences

        public void setOwnerReferences​(java.util.List<OwnerReference> 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.

      • setResourceVersion

        public void setResourceVersion​(java.lang.String 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

      • setSelfLink

        public void setSelfLink​(java.lang.String 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.

      • setUid

        public void setUid​(java.lang.String 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

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object