Class: Google::Apis::RunV1alpha1::ObjectMeta
- Inherits:
-
Object
- Object
- Google::Apis::RunV1alpha1::ObjectMeta
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/run_v1alpha1/classes.rb,
lib/google/apis/run_v1alpha1/representations.rb,
lib/google/apis/run_v1alpha1/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) Not supported by Cloud Run 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) Not supported by Cloud Run Number of seconds allowed for this object to gracefully terminate before it will be removed from the system.
-
#deletion_timestamp ⇒ String
(Optional) Not supported by Cloud Run DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.
-
#finalizers ⇒ Array<String>
(Optional) Not supported by Cloud Run Must be empty before the object is deleted from the registry.
-
#generate_name ⇒ String
(Optional) Not supported by Cloud Run 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::RunV1alpha1::OwnerReference>
(Optional) Not supported by Cloud Run List of objects that own this object.
-
#resource_version ⇒ String
Optional.
-
#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.
Constructor Details
#initialize(**args) ⇒ ObjectMeta
Returns a new instance of ObjectMeta.
1374 1375 1376 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1374 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: https://kubernetes.io/docs/user-guide/annotations
Corresponds to the JSON property annotations
1233 1234 1235 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1233 def annotations @annotations end |
#cluster_name ⇒ String
(Optional) Not supported by Cloud Run 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
1241 1242 1243 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1241 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
1251 1252 1253 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1251 def @creation_timestamp end |
#deletion_grace_period_seconds ⇒ Fixnum
(Optional) Not supported by Cloud Run 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
1258 1259 1260 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1258 def deletion_grace_period_seconds @deletion_grace_period_seconds end |
#deletion_timestamp ⇒ String
(Optional) Not supported by Cloud Run 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
1281 1282 1283 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1281 def @deletion_timestamp end |
#finalizers ⇒ Array<String>
(Optional) Not supported by Cloud Run 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
1290 1291 1292 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1290 def finalizers @finalizers end |
#generate_name ⇒ String
(Optional) Not supported by Cloud Run 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
1307 1308 1309 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1307 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
1313 1314 1315 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1313 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: https://kubernetes.io/docs/user-guide/
labels
Corresponds to the JSON property labels
1321 1322 1323 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1321 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: https://kubernetes.io/docs/user-guide/identifiers#names +
optional
Corresponds to the JSON property name
1331 1332 1333 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1331 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
1338 1339 1340 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1338 def namespace @namespace end |
#owner_references ⇒ Array<Google::Apis::RunV1alpha1::OwnerReference>
(Optional) Not supported by Cloud Run 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
1345 1346 1347 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1345 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 or omit the value to disable conflict-
detection. 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 or omitted. More info: https://git.k8s.io/community/contributors/
devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
Corresponds to the JSON property resourceVersion
1358 1359 1360 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1358 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
1364 1365 1366 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1364 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: https://kubernetes.io/docs/user-guide/identifiers#uids
Corresponds to the JSON property uid
1372 1373 1374 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1372 def uid @uid end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 |
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1379 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 |