Class: Kubernetes::V1ObjectMeta

Inherits:
Object
  • Object
show all
Defined in:
lib/kubernetes/models/v1_object_meta.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1ObjectMeta

Initializes the object



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 112

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.transform_keys(&:to_sym)

  if attributes.key?(:annotations) && (value = attributes[:annotations]).is_a?(Array)
    self.annotations = value
  end

  self.cluster_name = attributes[:clusterName] if attributes.key?(:clusterName)

  if attributes.key?(:creationTimestamp)
    self.creation_timestamp = attributes[:creationTimestamp]
  end

  if attributes.key?(:deletionGracePeriodSeconds)
    self.deletion_grace_period_seconds = attributes[:deletionGracePeriodSeconds]
  end

  if attributes.key?(:deletionTimestamp)
    self.deletion_timestamp = attributes[:deletionTimestamp]
  end

  if attributes.key?(:finalizers) && (value = attributes[:finalizers]).is_a?(Array)
    self.finalizers = value
  end

  self.generate_name = attributes[:generateName] if attributes.key?(:generateName)

  self.generation = attributes[:generation] if attributes.key?(:generation)

  self.initializers = attributes[:initializers] if attributes.key?(:initializers)

  if attributes.key?(:labels) && (value = attributes[:labels]).is_a?(Array)
    self.labels = value
  end

  self.name = attributes[:name] if attributes.key?(:name)

  self.namespace = attributes[:namespace] if attributes.key?(:namespace)

  if attributes.key?(:ownerReferences) && (value = attributes[:ownerReferences]).is_a?(Array)
    self.owner_references = value
  end

  self.resource_version = attributes[:resourceVersion] if attributes.key?(:resourceVersion)

  self.self_link = attributes[:selfLink] if attributes.key?(:selfLink)

  self.uid = attributes[:uid] if attributes.key?(:uid)
end

Instance Attribute Details

#annotations ⇒ Object

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: kubernetes.io/docs/user-guide/annotations



19
20
21
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 19

def annotations
  @annotations
end

#cluster_name ⇒ Object

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.



22
23
24
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 22

def cluster_name
  @cluster_name
end

#creation_timestamp ⇒ Object

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: git.k8s.io/community/contributors/devel/api-conventions.md#metadata



25
26
27
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 25

def creation_timestamp
  @creation_timestamp
end

#deletion_grace_period_seconds ⇒ Object

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.



28
29
30
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 28

def deletion_grace_period_seconds
  @deletion_grace_period_seconds
end

#deletion_timestamp ⇒ Object

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: git.k8s.io/community/contributors/devel/api-conventions.md#metadata



31
32
33
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 31

def deletion_timestamp
  @deletion_timestamp
end

#finalizers ⇒ Object

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.



34
35
36
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 34

def finalizers
  @finalizers
end

#generate_name ⇒ Object

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: git.k8s.io/community/contributors/devel/api-conventions.md#idempotency



37
38
39
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 37

def generate_name
  @generate_name
end

#generation ⇒ Object

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



40
41
42
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 40

def generation
  @generation
end

#initializers ⇒ Object

An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven’t explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.



43
44
45
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 43

def initializers
  @initializers
end

#labels ⇒ Object

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: kubernetes.io/docs/user-guide/labels



46
47
48
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 46

def labels
  @labels
end

#name ⇒ Object

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: kubernetes.io/docs/user-guide/identifiers#names



49
50
51
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 49

def name
  @name
end

#namespace ⇒ Object

Namespace defines the space within 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: kubernetes.io/docs/user-guide/namespaces



52
53
54
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 52

def namespace
  @namespace
end

#owner_references ⇒ Object

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.



55
56
57
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 55

def owner_references
  @owner_references
end

#resource_version ⇒ Object

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: git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency



58
59
60
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 58

def resource_version
  @resource_version
end

#self_link ⇒ Object

SelfLink is a URL representing this object. Populated by the system. Read-only.



61
62
63
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 61

def self_link
  @self_link
end

#uid ⇒ Object

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: kubernetes.io/docs/user-guide/identifiers#uids



64
65
66
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 64

def uid
  @uid
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 67

def self.attribute_map
  {
    annotations: :annotations,
    cluster_name: :clusterName,
    creation_timestamp: :creationTimestamp,
    deletion_grace_period_seconds: :deletionGracePeriodSeconds,
    deletion_timestamp: :deletionTimestamp,
    finalizers: :finalizers,
    generate_name: :generateName,
    generation: :generation,
    initializers: :initializers,
    labels: :labels,
    name: :name,
    namespace: :namespace,
    owner_references: :ownerReferences,
    resource_version: :resourceVersion,
    self_link: :selfLink,
    uid: :uid
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 89

def self.swagger_types
  {
    annotations: :'Hash<String, String>',
    cluster_name: :String,
    creation_timestamp: :DateTime,
    deletion_grace_period_seconds: :Integer,
    deletion_timestamp: :DateTime,
    finalizers: :'Array<String>',
    generate_name: :String,
    generation: :Integer,
    initializers: :V1Initializers,
    labels: :'Hash<String, String>',
    name: :String,
    namespace: :String,
    owner_references: :'Array<V1OwnerReference>',
    resource_version: :String,
    self_link: :String,
    uid: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 179

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    annotations == other.annotations &&
    cluster_name == other.cluster_name &&
    creation_timestamp == other.creation_timestamp &&
    deletion_grace_period_seconds == other.deletion_grace_period_seconds &&
    deletion_timestamp == other.deletion_timestamp &&
    finalizers == other.finalizers &&
    generate_name == other.generate_name &&
    generation == other.generation &&
    initializers == other.initializers &&
    labels == other.labels &&
    name == other.name &&
    namespace == other.namespace &&
    owner_references == other.owner_references &&
    resource_version == other.resource_version &&
    self_link == other.self_link &&
    uid == other.uid
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 241

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Kubernetes.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 308

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 217

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

See Also:

  • `==` method


203
204
205
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 203

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



209
210
211
212
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 209

def hash
  [annotations, cluster_name, creation_timestamp, deletion_grace_period_seconds,
   deletion_timestamp, finalizers, generate_name, generation, initializers, labels, name, namespace, owner_references, resource_version, self_link, uid].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



167
168
169
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 167

def list_invalid_properties
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



287
288
289
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 287

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



293
294
295
296
297
298
299
300
301
302
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 293

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    next if value.nil?

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



281
282
283
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 281

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



173
174
175
 
# File 'lib/kubernetes/models/v1_object_meta.rb', line 173

def valid?
  true
end