Class: Kubevirt::K8sIoApimachineryPkgApisMetaV1APIResource

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

Overview

APIResource specifies the name of a resource and whether it is namespaced.

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 = {}) ⇒ K8sIoApimachineryPkgApisMetaV1APIResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



99
100
101
102
103
104
105
106
107
108
109
110
111
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
164
165
166
167
168
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 99

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Kubevirt::K8sIoApimachineryPkgApisMetaV1APIResource` 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::K8sIoApimachineryPkgApisMetaV1APIResource`. 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?(:'categories')
    if (value = attributes[:'categories']).is_a?(Array)
      self.categories = value
    end
  end

  if attributes.key?(:'group')
    self.group = attributes[:'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?(:'namespaced')
    self.namespaced = attributes[:'namespaced']
  else
    self.namespaced = false
  end

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

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

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

  if attributes.key?(:'verbs')
    if (value = attributes[:'verbs']).is_a?(Array)
      self.verbs = value
    end
  else
    self.verbs = nil
  end

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

Instance Attribute Details

#categoriesObject

categories is a list of the grouped resources this resource belongs to (e.g. ‘all’)



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

def categories
  @categories
end

#groupObject

group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".



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

def group
  @group
end

#kindObject

kind is the kind for the resource (e.g. ‘Foo’ is the kind for a resource ‘foo’)



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

def kind
  @kind
end

#nameObject

name is the plural name of the resource.



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

def name
  @name
end

#namespacedObject

namespaced indicates if a resource is namespaced or not.



32
33
34
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 32

def namespaced
  @namespaced
end

#short_namesObject

shortNames is a list of suggested short names of the resource.



35
36
37
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 35

def short_names
  @short_names
end

#singular_nameObject

singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.



38
39
40
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 38

def singular_name
  @singular_name
end

#storage_version_hashObject

The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.



41
42
43
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 41

def storage_version_hash
  @storage_version_hash
end

#verbsObject

verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)



44
45
46
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 44

def verbs
  @verbs
end

#versionObject

version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource’s group)".



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

def version
  @version
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



66
67
68
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



71
72
73
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 50

def self.attribute_map
  {
    :'categories' => :'categories',
    :'group' => :'group',
    :'kind' => :'kind',
    :'name' => :'name',
    :'namespaced' => :'namespaced',
    :'short_names' => :'shortNames',
    :'singular_name' => :'singularName',
    :'storage_version_hash' => :'storageVersionHash',
    :'verbs' => :'verbs',
    :'version' => :'version'
  }
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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 292

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



92
93
94
95
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 92

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

.openapi_typesObject

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 76

def self.openapi_types
  {
    :'categories' => :'Array<String>',
    :'group' => :'String',
    :'kind' => :'String',
    :'name' => :'String',
    :'namespaced' => :'Boolean',
    :'short_names' => :'Array<String>',
    :'singular_name' => :'String',
    :'storage_version_hash' => :'String',
    :'verbs' => :'Array<String>',
    :'version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      categories == o.categories &&
      group == o.group &&
      kind == o.kind &&
      name == o.name &&
      namespaced == o.namespaced &&
      short_names == o.short_names &&
      singular_name == o.singular_name &&
      storage_version_hash == o.storage_version_hash &&
      verbs == o.verbs &&
      version == o.version
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


279
280
281
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 279

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



285
286
287
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 285

def hash
  [categories, group, kind, name, namespaced, short_names, singular_name, storage_version_hash, verbs, version].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 172

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

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

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

  if @verbs.nil?
    invalid_properties.push('invalid value for "verbs", verbs 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



314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 314

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



200
201
202
203
204
205
206
207
208
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_resource.rb', line 200

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