Class: Google::Apis::RunV1alpha1::ObjectMeta

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/run_v1alpha1/classes.rb,
generated/google/apis/run_v1alpha1/representations.rb,
generated/google/apis/run_v1alpha1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ObjectMeta

Returns a new instance of ObjectMeta.



3058
3059
3060
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 3058

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotationsHash<String,String>

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 +optional Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>)


2888
2889
2890
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2888

def annotations
  @annotations
end

#cluster_nameString

Not currently 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. +optional Corresponds to the JSON property clusterName

Returns:

  • (String)


2897
2898
2899
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2897

def cluster_name
  @cluster_name
end

#creation_timestampString

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 +optional Corresponds to the JSON property creationTimestamp

Returns:

  • (String)


2911
2912
2913
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2911

def creation_timestamp
  @creation_timestamp
end

#deletion_grace_period_secondsFixnum

Not currently 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. +optional Corresponds to the JSON property deletionGracePeriodSeconds

Returns:

  • (Fixnum)


2919
2920
2921
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2919

def deletion_grace_period_seconds
  @deletion_grace_period_seconds
end

#deletion_timestampString

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 +optional Corresponds to the JSON property deletionTimestamp

Returns:

  • (String)


2945
2946
2947
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2945

def deletion_timestamp
  @deletion_timestamp
end

#finalizersArray<String>

Not currently 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. +optional +patchStrategy=merge Corresponds to the JSON property finalizers

Returns:

  • (Array<String>)


2956
2957
2958
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2956

def finalizers
  @finalizers
end

#generate_nameString

Not currently 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 +optional string generateName = 2; Corresponds to the JSON property generateName

Returns:

  • (String)


2978
2979
2980
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2978

def generate_name
  @generate_name
end

#generationFixnum

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional Corresponds to the JSON property generation

Returns:

  • (Fixnum)


2985
2986
2987
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2985

def generation
  @generation
end

#labelsHash<String,String>

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 +optional Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)


2994
2995
2996
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2994

def labels
  @labels
end

#nameString

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

Returns:

  • (String)


3005
3006
3007
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 3005

def name
  @name
end

#namespaceString

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

Returns:

  • (String)


3012
3013
3014
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 3012

def namespace
  @namespace
end

#owner_referencesArray<Google::Apis::RunV1alpha1::OwnerReference>

List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional Corresponds to the JSON property ownerReferences



3019
3020
3021
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 3019

def owner_references
  @owner_references
end

#resource_versionString

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 +optional Corresponds to the JSON property resourceVersion

Returns:

  • (String)


3036
3037
3038
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 3036

def resource_version
  @resource_version
end

SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4; Corresponds to the JSON property selfLink

Returns:

  • (String)


3045
3046
3047
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 3045

def self_link
  @self_link
end

#uidString

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 +optional Corresponds to the JSON property uid

Returns:

  • (String)


3056
3057
3058
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 3056

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 3063

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