V1ObjectMeta (client-java-api 16.0.2 API)

java.lang.Object
- io.kubernetes.client.openapi.models.V1ObjectMeta

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-05-06T16:45:00.555Z[Etc/UTC]")
public class V1ObjectMeta
extends Object

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

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ANNOTATIONS`
`static String`	`SERIALIZED_NAME_CLUSTER_NAME`
`static String`	`SERIALIZED_NAME_CREATION_TIMESTAMP`
`static String`	`SERIALIZED_NAME_DELETION_GRACE_PERIOD_SECONDS`
`static String`	`SERIALIZED_NAME_DELETION_TIMESTAMP`
`static String`	`SERIALIZED_NAME_FINALIZERS`
`static String`	`SERIALIZED_NAME_GENERATE_NAME`
`static String`	`SERIALIZED_NAME_GENERATION`
`static String`	`SERIALIZED_NAME_LABELS`
`static String`	`SERIALIZED_NAME_MANAGED_FIELDS`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_NAMESPACE`
`static String`	`SERIALIZED_NAME_OWNER_REFERENCES`
`static String`	`SERIALIZED_NAME_RESOURCE_VERSION`
`static String`	`SERIALIZED_NAME_SELF_LINK`
`static String`	`SERIALIZED_NAME_UID`

Constructor Summary

Constructors
Constructor and Description

V1ObjectMeta()

Constructors
Constructor and Description
`V1ObjectMeta()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`V1ObjectMeta`	`addFinalizersItem(String finalizersItem)`
`V1ObjectMeta`	`addManagedFieldsItem(V1ManagedFieldsEntry managedFieldsItem)`
`V1ObjectMeta`	`addOwnerReferencesItem(V1OwnerReference ownerReferencesItem)`
`V1ObjectMeta`	`annotations(Map<String,String> annotations)`
`V1ObjectMeta`	`clusterName(String clusterName)`
`V1ObjectMeta`	`creationTimestamp(OffsetDateTime creationTimestamp)`
`V1ObjectMeta`	`deletionGracePeriodSeconds(Long deletionGracePeriodSeconds)`
`V1ObjectMeta`	`deletionTimestamp(OffsetDateTime deletionTimestamp)`
`boolean`	`equals(Object o)`
`V1ObjectMeta`	`finalizers(List<String> finalizers)`
`V1ObjectMeta`	`generateName(String generateName)`
`V1ObjectMeta`	`generation(Long generation)`
`Map<String,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.
`String`	`getClusterName()` Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25.
`OffsetDateTime`	`getCreationTimestamp()` CreationTimestamp is a timestamp representing the server time when this object was created.
`Long`	`getDeletionGracePeriodSeconds()` Number of seconds allowed for this object to gracefully terminate before it will be removed from the system.
`OffsetDateTime`	`getDeletionTimestamp()` DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.
`List<String>`	`getFinalizers()` Must be empty before the object is deleted from the registry.
`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.
`Long`	`getGeneration()` A sequence number representing a specific generation of the desired state.
`Map<String,String>`	`getLabels()` Map of string keys and values that can be used to organize and categorize (scope and select) objects.
`List<V1ManagedFieldsEntry>`	`getManagedFields()` ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow.
`String`	`getName()` Name must be unique within a namespace.
`String`	`getNamespace()` Namespace defines the space within which each name must be unique.
`List<V1OwnerReference>`	`getOwnerReferences()` List of objects depended by this object.
`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.
`String`	`getSelfLink()` Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
`String`	`getUid()` UID is the unique in time and space value for this object.
`int`	`hashCode()`
`V1ObjectMeta`	`labels(Map<String,String> labels)`
`V1ObjectMeta`	`managedFields(List<V1ManagedFieldsEntry> managedFields)`
`V1ObjectMeta`	`name(String name)`
`V1ObjectMeta`	`namespace(String namespace)`
`V1ObjectMeta`	`ownerReferences(List<V1OwnerReference> ownerReferences)`
`V1ObjectMeta`	`putAnnotationsItem(String key, String annotationsItem)`
`V1ObjectMeta`	`putLabelsItem(String key, String labelsItem)`
`V1ObjectMeta`	`resourceVersion(String resourceVersion)`
`V1ObjectMeta`	`selfLink(String selfLink)`
`void`	`setAnnotations(Map<String,String> annotations)`
`void`	`setClusterName(String clusterName)`
`void`	`setCreationTimestamp(OffsetDateTime creationTimestamp)`
`void`	`setDeletionGracePeriodSeconds(Long deletionGracePeriodSeconds)`
`void`	`setDeletionTimestamp(OffsetDateTime deletionTimestamp)`
`void`	`setFinalizers(List<String> finalizers)`
`void`	`setGenerateName(String generateName)`
`void`	`setGeneration(Long generation)`
`void`	`setLabels(Map<String,String> labels)`
`void`	`setManagedFields(List<V1ManagedFieldsEntry> managedFields)`
`void`	`setName(String name)`
`void`	`setNamespace(String namespace)`
`void`	`setOwnerReferences(List<V1OwnerReference> ownerReferences)`
`void`	`setResourceVersion(String resourceVersion)`
`void`	`setSelfLink(String selfLink)`
`void`	`setUid(String uid)`
`String`	`toString()`
`V1ObjectMeta`	`uid(String uid)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_ANNOTATIONS
```
public static final String SERIALIZED_NAME_ANNOTATIONS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CLUSTER_NAME
```
public static final String SERIALIZED_NAME_CLUSTER_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CREATION_TIMESTAMP
```
public static final String SERIALIZED_NAME_CREATION_TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DELETION_GRACE_PERIOD_SECONDS
```
public static final String SERIALIZED_NAME_DELETION_GRACE_PERIOD_SECONDS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DELETION_TIMESTAMP
```
public static final String SERIALIZED_NAME_DELETION_TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FINALIZERS
```
public static final String SERIALIZED_NAME_FINALIZERS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_GENERATE_NAME
```
public static final String SERIALIZED_NAME_GENERATE_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_GENERATION
```
public static final String SERIALIZED_NAME_GENERATION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LABELS
```
public static final String SERIALIZED_NAME_LABELS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MANAGED_FIELDS
```
public static final String SERIALIZED_NAME_MANAGED_FIELDS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAMESPACE
```
public static final String SERIALIZED_NAME_NAMESPACE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_OWNER_REFERENCES
```
public static final String SERIALIZED_NAME_OWNER_REFERENCES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_RESOURCE_VERSION
```
public static final String SERIALIZED_NAME_RESOURCE_VERSION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SELF_LINK
```
public static final String SERIALIZED_NAME_SELF_LINK
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_UID
```
public static final String SERIALIZED_NAME_UID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - V1ObjectMeta
```
public V1ObjectMeta()
```
- Method Detail
  - annotations
```
public V1ObjectMeta annotations(Map<String,String> annotations)
```
  - putAnnotationsItem
```
public V1ObjectMeta putAnnotationsItem(String key,
                                       String annotationsItem)
```
  - getAnnotations
```
@Nullable
public Map<String,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
    
    Returns:
    
    annotations
  - setAnnotations
```
public void setAnnotations(Map<String,String> annotations)
```
  - clusterName
```
public V1ObjectMeta clusterName(String clusterName)
```
  - getClusterName
```
@Nullable
public String getClusterName()
```
    Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental use.
    
    Returns:
    
    clusterName
  - setClusterName
```
public void setClusterName(String clusterName)
```
  - creationTimestamp
```
public V1ObjectMeta creationTimestamp(OffsetDateTime creationTimestamp)
```
  - getCreationTimestamp
```
@Nullable
public OffsetDateTime getCreationTimestamp()
```
    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    
    Returns:
    
    creationTimestamp
  - setCreationTimestamp
```
public void setCreationTimestamp(OffsetDateTime creationTimestamp)
```
  - deletionGracePeriodSeconds
```
public V1ObjectMeta deletionGracePeriodSeconds(Long deletionGracePeriodSeconds)
```
  - getDeletionGracePeriodSeconds
```
@Nullable
public Long 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.
    
    Returns:
    
    deletionGracePeriodSeconds
  - setDeletionGracePeriodSeconds
```
public void setDeletionGracePeriodSeconds(Long deletionGracePeriodSeconds)
```
  - deletionTimestamp
```
public V1ObjectMeta deletionTimestamp(OffsetDateTime deletionTimestamp)
```
  - getDeletionTimestamp
```
@Nullable
public OffsetDateTime getDeletionTimestamp()
```
    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    
    Returns:
    
    deletionTimestamp
  - setDeletionTimestamp
```
public void setDeletionTimestamp(OffsetDateTime deletionTimestamp)
```
  - finalizers
```
public V1ObjectMeta finalizers(List<String> finalizers)
```
  - addFinalizersItem
```
public V1ObjectMeta addFinalizersItem(String finalizersItem)
```
  - getFinalizers
```
@Nullable
public List<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.
    
    Returns:
    
    finalizers
  - setFinalizers
```
public void setFinalizers(List<String> finalizers)
```
  - generateName
```
public V1ObjectMeta generateName(String generateName)
```
  - getGenerateName
```
@Nullable
public 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 return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
    
    Returns:
    
    generateName
  - setGenerateName
```
public void setGenerateName(String generateName)
```
  - generation
```
public V1ObjectMeta generation(Long generation)
```
  - getGeneration
```
@Nullable
public Long getGeneration()
```
    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
    
    Returns:
    
    generation
  - setGeneration
```
public void setGeneration(Long generation)
```
  - labels
```
public V1ObjectMeta labels(Map<String,String> labels)
```
  - putLabelsItem
```
public V1ObjectMeta putLabelsItem(String key,
                                  String labelsItem)
```
  - getLabels
```
@Nullable
public Map<String,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
    
    Returns:
    
    labels
  - setLabels
```
public void setLabels(Map<String,String> labels)
```
  - managedFields
```
public V1ObjectMeta managedFields(List<V1ManagedFieldsEntry> managedFields)
```
  - addManagedFieldsItem
```
public V1ObjectMeta addManagedFieldsItem(V1ManagedFieldsEntry managedFieldsItem)
```
  - getManagedFields
```
@Nullable
public List<V1ManagedFieldsEntry> 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.
    
    Returns:
    
    managedFields
  - setManagedFields
```
public void setManagedFields(List<V1ManagedFieldsEntry> managedFields)
```
  - name
```
public V1ObjectMeta name(String name)
```
  - getName
```
@Nullable
public 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
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - namespace
```
public V1ObjectMeta namespace(String namespace)
```
  - getNamespace
```
@Nullable
public 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
    
    Returns:
    
    namespace
  - setNamespace
```
public void setNamespace(String namespace)
```
  - ownerReferences
```
public V1ObjectMeta ownerReferences(List<V1OwnerReference> ownerReferences)
```
  - addOwnerReferencesItem
```
public V1ObjectMeta addOwnerReferencesItem(V1OwnerReference ownerReferencesItem)
```
  - getOwnerReferences
```
@Nullable
public List<V1OwnerReference> 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.
    
    Returns:
    
    ownerReferences
  - setOwnerReferences
```
public void setOwnerReferences(List<V1OwnerReference> ownerReferences)
```
  - resourceVersion
```
public V1ObjectMeta resourceVersion(String resourceVersion)
```
  - getResourceVersion
```
@Nullable
public 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
    
    Returns:
    
    resourceVersion
  - setResourceVersion
```
public void setResourceVersion(String resourceVersion)
```
  - selfLink
```
public V1ObjectMeta selfLink(String selfLink)
```
  - getSelfLink
```
@Nullable
public String getSelfLink()
```
    Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
    
    Returns:
    
    selfLink
  - setSelfLink
```
public void setSelfLink(String selfLink)
```
  - uid
```
public V1ObjectMeta uid(String uid)
```
  - getUid
```
@Nullable
public 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
    
    Returns:
    
    uid
  - setUid
```
public void setUid(String uid)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class V1ObjectMeta

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ANNOTATIONS

SERIALIZED_NAME_CLUSTER_NAME

SERIALIZED_NAME_CREATION_TIMESTAMP

SERIALIZED_NAME_DELETION_GRACE_PERIOD_SECONDS

SERIALIZED_NAME_DELETION_TIMESTAMP

SERIALIZED_NAME_FINALIZERS

SERIALIZED_NAME_GENERATE_NAME

SERIALIZED_NAME_GENERATION

SERIALIZED_NAME_LABELS

SERIALIZED_NAME_MANAGED_FIELDS

SERIALIZED_NAME_NAME

SERIALIZED_NAME_NAMESPACE

SERIALIZED_NAME_OWNER_REFERENCES

SERIALIZED_NAME_RESOURCE_VERSION

SERIALIZED_NAME_SELF_LINK

SERIALIZED_NAME_UID

Constructor Detail

V1ObjectMeta

Method Detail

annotations

putAnnotationsItem

getAnnotations

setAnnotations

clusterName

getClusterName

setClusterName

creationTimestamp

getCreationTimestamp

setCreationTimestamp

deletionGracePeriodSeconds

getDeletionGracePeriodSeconds

setDeletionGracePeriodSeconds

deletionTimestamp

getDeletionTimestamp

setDeletionTimestamp

finalizers

addFinalizersItem

getFinalizers

setFinalizers

generateName

getGenerateName

setGenerateName

generation

getGeneration

setGeneration

labels

putLabelsItem

getLabels

setLabels

managedFields

addManagedFieldsItem

getManagedFields

setManagedFields

name

getName

setName

namespace

getNamespace

setNamespace

ownerReferences

addOwnerReferencesItem

getOwnerReferences

setOwnerReferences

resourceVersion

getResourceVersion

setResourceVersion

selfLink

getSelfLink

setSelfLink

uid

getUid

setUid

equals

hashCode