Class: Google::Apis::RunV1beta1::ObjectMeta
- Inherits:
-
Object
- Object
- Google::Apis::RunV1beta1::ObjectMeta
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/run_v1beta1/classes.rb,
generated/google/apis/run_v1beta1/representations.rb,
generated/google/apis/run_v1beta1/representations.rb
Overview
k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
Instance Attribute Summary collapse
-
#annotations ⇒ Hash<String,String>
(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.
-
#cluster_name ⇒ String
(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported The name of the cluster which the object belongs to.
-
#creation_timestamp ⇒ String
(Optional) CreationTimestamp is a timestamp representing the server time when this object was created.
-
#deletion_grace_period_seconds ⇒ Fixnum
(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.
-
#deletion_timestamp ⇒ String
(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.
-
#finalizers ⇒ Array<String>
(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Must be empty before the object is deleted from the registry.
-
#generate_name ⇒ String
(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.
-
#generation ⇒ Fixnum
(Optional) A sequence number representing a specific generation of the desired state.
-
#labels ⇒ Hash<String,String>
(Optional) Map of string keys and values that can be used to organize and categorize (scope and select) objects.
-
#name ⇒ String
Name must be unique within a namespace, within a Cloud Run region.
-
#namespace ⇒ String
Namespace defines the space within each name must be unique, within a Cloud Run region.
-
#owner_references ⇒ Array<Google::Apis::RunV1beta1::OwnerReference>
(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported List of objects that own this object.
-
#resource_version ⇒ String
(Optional) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed.
-
#self_link ⇒ String
(Optional) SelfLink is a URL representing this object.
-
#uid ⇒ String
(Optional) UID is the unique in time and space value for this object.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ObjectMeta
constructor
A new instance of ObjectMeta.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ObjectMeta
Returns a new instance of ObjectMeta.
1082 1083 1084 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 1082 def initialize(**args) update!(**args) end |
Instance Attribute Details
#annotations ⇒ Hash<String,String>
(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
Corresponds to the JSON property annotations
902 903 904 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 902 def annotations @annotations end |
#cluster_name ⇒ String
(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.
Corresponds to the JSON property clusterName
913 914 915 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 913 def cluster_name @cluster_name end |
#creation_timestamp ⇒ String
(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
Corresponds to the JSON property creationTimestamp
927 928 929 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 927 def @creation_timestamp end |
#deletion_grace_period_seconds ⇒ Fixnum
(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.
Corresponds to the JSON property deletionGracePeriodSeconds
937 938 939 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 937 def deletion_grace_period_seconds @deletion_grace_period_seconds end |
#deletion_timestamp ⇒ String
(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
Corresponds to the JSON property deletionTimestamp
965 966 967 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 965 def @deletion_timestamp end |
#finalizers ⇒ Array<String>
(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
Corresponds to the JSON property finalizers
977 978 979 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 977 def finalizers @finalizers end |
#generate_name ⇒ String
(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;
Corresponds to the JSON property generateName
1000 1001 1002 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 1000 def generate_name @generate_name end |
#generation ⇒ Fixnum
(Optional)
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
Corresponds to the JSON property generation
1007 1008 1009 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 1007 def generation @generation end |
#labels ⇒ Hash<String,String>
(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
Corresponds to the JSON property labels
1016 1017 1018 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 1016 def labels @labels end |
#name ⇒ String
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
Corresponds to the JSON property name
1027 1028 1029 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 1027 def name @name end |
#namespace ⇒ String
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.
Corresponds to the JSON property namespace
1034 1035 1036 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 1034 def namespace @namespace end |
#owner_references ⇒ Array<Google::Apis::RunV1beta1::OwnerReference>
(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.
Corresponds to the JSON property ownerReferences
1043 1044 1045 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 1043 def owner_references @owner_references end |
#resource_version ⇒ String
(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 and .
More info:
https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-
control-and-consistency
Corresponds to the JSON property resourceVersion
1060 1061 1062 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 1060 def resource_version @resource_version end |
#self_link ⇒ String
(Optional)
SelfLink is a URL representing this object.
Populated by the system.
Read-only.
string selfLink = 4;
Corresponds to the JSON property selfLink
1069 1070 1071 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 1069 def self_link @self_link end |
#uid ⇒ String
(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
Corresponds to the JSON property uid
1080 1081 1082 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 1080 def uid @uid end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 |
# File 'generated/google/apis/run_v1beta1/classes.rb', line 1087 def update!(**args) @annotations = args[:annotations] if args.key?(:annotations) @cluster_name = args[:cluster_name] if args.key?(:cluster_name) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @deletion_grace_period_seconds = args[:deletion_grace_period_seconds] if args.key?(:deletion_grace_period_seconds) @deletion_timestamp = args[:deletion_timestamp] if args.key?(:deletion_timestamp) @finalizers = args[:finalizers] if args.key?(:finalizers) @generate_name = args[:generate_name] if args.key?(:generate_name) @generation = args[:generation] if args.key?(:generation) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @namespace = args[:namespace] if args.key?(:namespace) @owner_references = args[:owner_references] if args.key?(:owner_references) @resource_version = args[:resource_version] if args.key?(:resource_version) @self_link = args[:self_link] if args.key?(:self_link) @uid = args[:uid] if args.key?(:uid) end |