com.google.api.services.run.v1.model

Class ObjectMeta

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.run.v1.model.ObjectMeta

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ObjectMeta
extends GenericJson

k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Run Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ObjectMeta()

Method Summary

Modifier and Type	Method and Description
ObjectMeta	clone()
Map<String,String>	getAnnotations() (Optional) 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() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported The name of the cluster which the object belongs to.
String	getCreationTimestamp() (Optional) CreationTimestamp is a timestamp representing the server time when this object was created.
Integer	getDeletionGracePeriodSeconds() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds allowed for this object to gracefully terminate before it will be removed from the system.
String	getDeletionTimestamp() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.
List<String>	getFinalizers() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Must be empty before the object is deleted from the registry.
String	getGenerateName() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided.
Integer	getGeneration() (Optional) A sequence number representing a specific generation of the desired state.
Map<String,String>	getLabels() (Optional) Map of string keys and values that can be used to organize and categorize (scope and select) objects.
String	getName() Name must be unique within a namespace, within a Cloud Run region.
String	getNamespace() Namespace defines the space within each name must be unique, within a Cloud Run region.
List<OwnerReference>	getOwnerReferences() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported List of objects that own this object.
String	getResourceVersion() (Optional) 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() (Optional) SelfLink is a URL representing this object.
String	getUid() (Optional) UID is the unique in time and space value for this object.
ObjectMeta	set(String fieldName, Object value)
ObjectMeta	setAnnotations(Map<String,String> annotations) (Optional) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
ObjectMeta	setClusterName(String clusterName) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported The name of the cluster which the object belongs to.
ObjectMeta	setCreationTimestamp(String creationTimestamp) (Optional) CreationTimestamp is a timestamp representing the server time when this object was created.
ObjectMeta	setDeletionGracePeriodSeconds(Integer deletionGracePeriodSeconds) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds allowed for this object to gracefully terminate before it will be removed from the system.
ObjectMeta	setDeletionTimestamp(String deletionTimestamp) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.
ObjectMeta	setFinalizers(List<String> finalizers) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Must be empty before the object is deleted from the registry.
ObjectMeta	setGenerateName(String generateName) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided.
ObjectMeta	setGeneration(Integer generation) (Optional) A sequence number representing a specific generation of the desired state.
ObjectMeta	setLabels(Map<String,String> labels) (Optional) Map of string keys and values that can be used to organize and categorize (scope and select) objects.
ObjectMeta	setName(String name) Name must be unique within a namespace, within a Cloud Run region.
ObjectMeta	setNamespace(String namespace) Namespace defines the space within each name must be unique, within a Cloud Run region.
ObjectMeta	setOwnerReferences(List<OwnerReference> ownerReferences) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported List of objects that own this object.
ObjectMeta	setResourceVersion(String resourceVersion) (Optional) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed.
ObjectMeta	setSelfLink(String selfLink) (Optional) SelfLink is a URL representing this object.
ObjectMeta	setUid(String uid) (Optional) UID is the unique in time and space value for this object.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ObjectMeta

public ObjectMeta()

Method Detail

getAnnotations

public Map<String,String> getAnnotations()

(Optional) 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:

value or null for none

setAnnotations

public ObjectMeta setAnnotations(Map<String,String> annotations)

(Optional) 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

Parameters:

annotations - annotations or null for none

getClusterName

public String getClusterName()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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.

Returns:

value or null for none

setClusterName

public ObjectMeta setClusterName(String clusterName)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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.

Parameters:

clusterName - clusterName or null for none

getCreationTimestamp

public String getCreationTimestamp()

(Optional) 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/api-conventions.md#metadata

Returns:

value or null for none

setCreationTimestamp

public ObjectMeta setCreationTimestamp(String creationTimestamp)

(Optional) 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/api-conventions.md#metadata

Parameters:

creationTimestamp - creationTimestamp or null for none

getDeletionGracePeriodSeconds

public Integer getDeletionGracePeriodSeconds()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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:

value or null for none

setDeletionGracePeriodSeconds

public ObjectMeta setDeletionGracePeriodSeconds(Integer deletionGracePeriodSeconds)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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.

Parameters:

deletionGracePeriodSeconds - deletionGracePeriodSeconds or null for none

getDeletionTimestamp

public String getDeletionTimestamp()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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/api-conventions.md#metadata

Returns:

value or null for none

setDeletionTimestamp

public ObjectMeta setDeletionTimestamp(String deletionTimestamp)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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/api-conventions.md#metadata

Parameters:

deletionTimestamp - deletionTimestamp or null for none

getFinalizers

public List<String> getFinalizers()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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. +patchStrategy=merge

Returns:

value or null for none

setFinalizers

public ObjectMeta setFinalizers(List<String> finalizers)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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. +patchStrategy=merge

Parameters:

finalizers - finalizers or null for none

getGenerateName

public String getGenerateName()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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/api-conventions.md#idempotency string generateName = 2;

Returns:

value or null for none

setGenerateName

public ObjectMeta setGenerateName(String generateName)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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/api-conventions.md#idempotency string generateName = 2;

Parameters:

generateName - generateName or null for none

getGeneration

public Integer getGeneration()

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

Returns:

value or null for none

setGeneration

public ObjectMeta setGeneration(Integer generation)

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

Parameters:

generation - generation or null for none

getLabels

public Map<String,String> getLabels()

(Optional) 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 routes. More info: http://kubernetes.io/docs/user-guide/labels

Returns:

value or null for none

setLabels

public ObjectMeta setLabels(Map<String,String> labels)

(Optional) 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 routes. More info: http://kubernetes.io/docs/user-guide/labels

Parameters:

labels - labels or null for none

getName

public String getName()

Name must be unique within a namespace, within a Cloud Run region. 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 +optional

Returns:

value or null for none

setName

public ObjectMeta setName(String name)

Name must be unique within a namespace, within a Cloud Run region. 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 +optional

Parameters:

name - name or null for none

getNamespace

public String getNamespace()

Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number.

Returns:

value or null for none

setNamespace

public ObjectMeta setNamespace(String namespace)

Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number.

Parameters:

namespace - namespace or null for none

getOwnerReferences

public List<OwnerReference> getOwnerReferences()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected.

Returns:

value or null for none

setOwnerReferences

public ObjectMeta setOwnerReferences(List<OwnerReference> ownerReferences)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected.

Parameters:

ownerReferences - ownerReferences or null for none

getResourceVersion

public String getResourceVersion()

(Optional) 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. More info: https://git.k8s.io/community/contributors/devel/sig- architecture/api-conventions.md#concurrency-control-and-consistency

Returns:

value or null for none

setResourceVersion

public ObjectMeta setResourceVersion(String resourceVersion)

(Optional) 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. More info: https://git.k8s.io/community/contributors/devel/sig- architecture/api-conventions.md#concurrency-control-and-consistency

Parameters:

resourceVersion - resourceVersion or null for none

getSelfLink

public String getSelfLink()

(Optional) SelfLink is a URL representing this object. Populated by the system. Read-only. string selfLink = 4;

Returns:

value or null for none

setSelfLink

public ObjectMeta setSelfLink(String selfLink)

(Optional) SelfLink is a URL representing this object. Populated by the system. Read-only. string selfLink = 4;

Parameters:

selfLink - selfLink or null for none

getUid

public String getUid()

(Optional) 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:

value or null for none

setUid

public ObjectMeta setUid(String uid)

(Optional) 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

Parameters:

uid - uid or null for none

set

public ObjectMeta set(String fieldName,
                      Object value)

Overrides:

set in class GenericJson

clone

public ObjectMeta clone()

Overrides:

clone in class GenericJson