Class: Kubevirt::K8sIoApiCoreV1TypedObjectReference

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb

Overview

TypedObjectReference contains enough information to let you locate the typed referenced object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ K8sIoApiCoreV1TypedObjectReference

Initializes the object

Parameters:

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

    Model attributes in the form of hash



69
70
71
72
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/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 69

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Kubevirt::K8sIoApiCoreV1TypedObjectReference` initialize method"
  end

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

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

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

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

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

Instance Attribute Details

#api_groupObject

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.



20
21
22
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 20

def api_group
  @api_group
end

#kindObject

Kind is the type of resource being referenced



23
24
25
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 23

def kind
  @kind
end

#nameObject

Name is the name of resource being referenced



26
27
28
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 26

def name
  @name
end

#namespaceObject

Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace’s owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.



29
30
31
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 29

def namespace
  @namespace
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



42
43
44
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 42

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



47
48
49
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 47

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



32
33
34
35
36
37
38
39
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 32

def self.attribute_map
  {
    :'api_group' => :'apiGroup',
    :'kind' => :'kind',
    :'name' => :'name',
    :'namespace' => :'namespace'
  }
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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 175

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullableObject

List of attributes with nullable: true



62
63
64
65
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 62

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

.openapi_typesObject

Attribute type mapping.



52
53
54
55
56
57
58
59
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 52

def self.openapi_types
  {
    :'api_group' => :'String',
    :'kind' => :'String',
    :'name' => :'String',
    :'namespace' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



151
152
153
154
155
156
157
158
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      api_group == o.api_group &&
      kind == o.kind &&
      name == o.name &&
      namespace == o.namespace
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


162
163
164
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 162

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



168
169
170
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 168

def hash
  [api_group, kind, name, namespace].hash
end

#list_invalid_propertiesObject

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
118
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 106

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @kind.nil?
    invalid_properties.push('invalid value for "kind", kind cannot be nil.')
  end

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

  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 197

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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

#valid?Boolean

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

Returns:

  • (Boolean)

    true if the model is valid



122
123
124
125
126
127
# File 'lib/kubevirt/models/k8s_io_api_core_v1_typed_object_reference.rb', line 122

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @kind.nil?
  return false if @name.nil?
  true
end