Class: Zilla::IoK8sApimachineryPkgApisMetaV1OwnerReference

Inherits:
Object
  • Object
show all
Defined in:
lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb

Overview

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApimachineryPkgApisMetaV1OwnerReference

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 73

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `Zilla::IoK8sApimachineryPkgApisMetaV1OwnerReference` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError,
            "`#{k}` is not a valid attribute in `Zilla::IoK8sApimachineryPkgApisMetaV1OwnerReference`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end

    h[k.to_sym] = v
  end

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

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

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

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

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

  return unless attributes.key?(:uid)

  self.uid = attributes[:uid]
end

Instance Attribute Details

#api_version ⇒ Object

API version of the referent.



20
21
22
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 20

def api_version
  @api_version
end

#block_owner_deletion ⇒ Object

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.



23
24
25
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 23

def block_owner_deletion
  @block_owner_deletion
end

#controller ⇒ Object

If true, this reference points to the managing controller.



26
27
28
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 26

def controller
  @controller
end

#kind ⇒ Object

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



29
30
31
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 29

def kind
  @kind
end

#name ⇒ Object

Name of the referent. More info: kubernetes.io/docs/user-guide/identifiers#names



32
33
34
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 32

def name
  @name
end

#uid ⇒ Object

UID of the referent. More info: kubernetes.io/docs/user-guide/identifiers#uids



35
36
37
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 35

def uid
  @uid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 50

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 38

def self.attribute_map
  {
    api_version: :apiVersion,
    block_owner_deletion: :blockOwnerDeletion,
    controller: :controller,
    kind: :kind,
    name: :name,
    uid: :uid
  }
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



159
160
161
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 159

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 67

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 55

def self.openapi_types
  {
    api_version: :String,
    block_owner_deletion: :Boolean,
    controller: :Boolean,
    kind: :String,
    name: :String,
    uid: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 132

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

  self.class == other.class &&
    api_version == other.api_version &&
    block_owner_deletion == other.block_owner_deletion &&
    controller == other.controller &&
    kind == other.kind &&
    name == other.name &&
    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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 193

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Zilla.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 264

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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 166

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

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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


146
147
148
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 146

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



152
153
154
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 152

def hash
  [api_version, block_owner_deletion, controller, kind, name, uid].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 106

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "api_version", api_version cannot be nil.') if @api_version.nil?

  invalid_properties.push('invalid value for "kind", kind cannot be nil.') if @kind.nil?

  invalid_properties.push('invalid value for "name", name cannot be nil.') if @name.nil?

  invalid_properties.push('invalid value for "uid", uid cannot be nil.') if @uid.nil?

  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



240
241
242
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 240

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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 246

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



234
235
236
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 234

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



121
122
123
124
125
126
127
128
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_owner_reference.rb', line 121

def valid?
  return false if @api_version.nil?
  return false if @kind.nil?
  return false if @name.nil?
  return false if @uid.nil?

  true
end