Class: Kubevirt::K8sIoApimachineryPkgApisMetaV1APIGroup

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

Overview

APIGroup contains the name, the supported versions, and the preferred version of a group.

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

Initializes the object



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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 78

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

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

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

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

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

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

Instance Attribute Details

#api_versionObject

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources



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

def api_version
  @api_version
end

#kindObject

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds



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

def kind
  @kind
end

#nameObject

name is the name of the group.



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

def name
  @name
end

#preferred_versionObject

Returns the value of attribute preferred_version.



28
29
30
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 28

def preferred_version
  @preferred_version
end

#server_address_by_client_cidrsObject

a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.



31
32
33
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 31

def server_address_by_client_cidrs
  @server_address_by_client_cidrs
end

#versionsObject

versions are the versions supported in this group.



34
35
36
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 34

def versions
  @versions
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



49
50
51
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 49

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



54
55
56
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 54

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



37
38
39
40
41
42
43
44
45
46
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 37

def self.attribute_map
  {
    :'api_version' => :'apiVersion',
    :'kind' => :'kind',
    :'name' => :'name',
    :'preferred_version' => :'preferredVersion',
    :'server_address_by_client_cidrs' => :'serverAddressByClientCIDRs',
    :'versions' => :'versions'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 198

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



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

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

.openapi_typesObject

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 59

def self.openapi_types
  {
    :'api_version' => :'String',
    :'kind' => :'String',
    :'name' => :'String',
    :'preferred_version' => :'K8sIoApimachineryPkgApisMetaV1GroupVersionForDiscovery',
    :'server_address_by_client_cidrs' => :'Array<K8sIoApimachineryPkgApisMetaV1ServerAddressByClientCIDR>',
    :'versions' => :'Array<K8sIoApimachineryPkgApisMetaV1GroupVersionForDiscovery>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



172
173
174
175
176
177
178
179
180
181
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 172

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      api_version == o.api_version &&
      kind == o.kind &&
      name == o.name &&
      preferred_version == o.preferred_version &&
      server_address_by_client_cidrs == o.server_address_by_client_cidrs &&
      versions == o.versions
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


185
186
187
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 185

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.



191
192
193
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 191

def hash
  [api_version, kind, name, preferred_version, server_address_by_client_cidrs, versions].hash
end

#list_invalid_propertiesObject

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



127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 127

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

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

  invalid_properties
end

#to_hashHash

Returns the object in the form of hash



220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 220

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



143
144
145
146
147
148
# File 'lib/kubevirt/models/k8s_io_apimachinery_pkg_apis_meta_v1_api_group.rb', line 143

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