Class: Kubernetes::V1ObjectReference

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

Overview

ObjectReference contains enough information to let you inspect or modify the referred object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1ObjectReference

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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_reference.rb', line 67

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#api_version ⇒ Object

API version of the referent.



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

def api_version
  @api_version
end

#field_path ⇒ Object

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers#name" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.



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

def field_path
  @field_path
end

#kind ⇒ Object

Kind of the referent. More info: git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds



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

def kind
  @kind
end

#name ⇒ Object

Name of the referent. More info: kubernetes.io/docs/concepts/overview/working-with-objects/names/#names



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

def name
  @name
end

#namespace ⇒ Object

Namespace of the referent. More info: kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/



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

def namespace
  @namespace
end

#resource_version ⇒ Object

Specific resourceVersion to which this reference is made, if any. More info: git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency



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

def resource_version
  @resource_version
end

#uid ⇒ Object

UID of the referent. More info: kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids



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

def uid
  @uid
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/kubernetes/models/v1_object_reference.rb', line 40

def self.attribute_map
  {
    api_version: :apiVersion,
    field_path: :fieldPath,
    kind: :kind,
    name: :name,
    namespace: :namespace,
    resource_version: :resourceVersion,
    uid: :uid
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/kubernetes/models/v1_object_reference.rb', line 53

def self.swagger_types
  {
    api_version: :String,
    field_path: :String,
    kind: :String,
    name: :String,
    namespace: :String,
    resource_version: :String,
    uid: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/kubernetes/models/v1_object_reference.rb', line 102

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

  self.class == other.class &&
    api_version == other.api_version &&
    field_path == other.field_path &&
    kind == other.kind &&
    name == other.name &&
    namespace == other.namespace &&
    resource_version == other.resource_version &&
    uid == other.uid
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/kubernetes/models/v1_object_reference.rb', line 154

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/kubernetes/models/v1_object_reference.rb', line 221

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/kubernetes/models/v1_object_reference.rb', line 130

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


117
118
119
 
# File 'lib/kubernetes/models/v1_object_reference.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



123
124
125
 
# File 'lib/kubernetes/models/v1_object_reference.rb', line 123

def hash
  [api_version, field_path, kind, name, namespace, resource_version, uid].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



90
91
92
 
# File 'lib/kubernetes/models/v1_object_reference.rb', line 90

def list_invalid_properties
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



200
201
202
 
# File 'lib/kubernetes/models/v1_object_reference.rb', line 200

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/kubernetes/models/v1_object_reference.rb', line 206

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

Returns:

  • (String) —

    String presentation of the object



194
195
196
 
# File 'lib/kubernetes/models/v1_object_reference.rb', line 194

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



96
97
98
 
# File 'lib/kubernetes/models/v1_object_reference.rb', line 96

def valid?
  true
end