Class: IntersightClient::HyperflexServiceAuthToken

Inherits:
MoBaseMo
  • Object
show all
Defined in:
lib/intersight_client/models/hyperflex_service_auth_token.rb

Overview

A Service auth token entity that represents HyperFlex Data Platform service AAA token.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HyperflexServiceAuthToken

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 126

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

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

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'hyperflex.ServiceAuthToken'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'hyperflex.ServiceAuthToken'
  end

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

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

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

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

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

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

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

Instance Attribute Details

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 20

def class_id
  @class_id
end

#client_id ⇒ Object

Client Id or tenant Id of the entity that uses the service auth token.



26
27
28
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 26

def client_id
  @client_id
end

#cluster ⇒ Object

Returns the value of attribute cluster.



37
38
39
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 37

def cluster
  @cluster
end

#csi_version ⇒ Object

Version of Container Storage Interface (CSI) that the tokenOwner is associated with.



29
30
31
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 29

def csi_version
  @csi_version
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 23

def object_type
  @object_type
end

#organization ⇒ Object

Returns the value of attribute organization.



39
40
41
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 39

def organization
  @organization
end

#service_auth_token ⇒ Object

Service auth token that has been created by HyperFlex cluster.



32
33
34
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 32

def service_auth_token
  @service_auth_token
end

#status ⇒ Object

Represents status of ervice auth claim or revocation. * ‘Unknown` - Unknown claim state of the service auth token. * `Claiming` - The service auth token claim is in progress. * `Claimed` - The service auth token has been successfully claimed. * `FailedToClaim` - Cannot claim the service auth token on the underlying HyperFlex cluster. * `Revoking` - The service auth token revocation is in progress. * `Revoked` - The service auth token revocation has been successfully revoked. * `FailedToRevoke` - Cannot revoke the service auth token on the underlying HyperFlex cluster.



35
36
37
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 35

def status
  @status
end

#token_owner ⇒ Object

Returns the value of attribute token_owner.



41
42
43
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 41

def token_owner
  @token_owner
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



86
87
88
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 86

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



81
82
83
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 81

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 66

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'client_id' => :'ClientId',
    :'csi_version' => :'CsiVersion',
    :'service_auth_token' => :'ServiceAuthToken',
    :'status' => :'Status',
    :'cluster' => :'Cluster',
    :'organization' => :'Organization',
    :'token_owner' => :'TokenOwner'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



275
276
277
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 275

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



112
113
114
115
116
117
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 112

def self.openapi_all_of
  [
  :'HyperflexServiceAuthTokenAllOf',
  :'MoBaseMo'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



120
121
122
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 120

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 106

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 91

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'client_id' => :'String',
    :'csi_version' => :'String',
    :'service_auth_token' => :'String',
    :'status' => :'String',
    :'cluster' => :'HyperflexClusterRelationship',
    :'organization' => :'OrganizationOrganizationRelationship',
    :'token_owner' => :'MoBaseMoRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      client_id == o.client_id &&
      csi_version == o.csi_version &&
      service_auth_token == o.service_auth_token &&
      status == o.status &&
      cluster == o.cluster &&
      organization == o.organization &&
      token_owner == o.token_owner && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 306

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 = IntersightClient.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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 377

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 282

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


262
263
264
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 262

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



268
269
270
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 268

def hash
  [class_id, object_type, client_id, csi_version, service_auth_token, status, cluster, organization, token_owner].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



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 187

def list_invalid_properties
  invalid_properties = super
  if @class_id.nil?
    invalid_properties.push('invalid value for "class_id", class_id cannot be nil.')
  end

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



353
354
355
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 353

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 359

def to_hash
  hash = super
  HyperflexServiceAuthToken.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = HyperflexServiceAuthToken.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 presentation of the object



347
348
349
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 347

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • true if the model is valid



202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/intersight_client/models/hyperflex_service_auth_token.rb', line 202

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hyperflex.ServiceAuthToken"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hyperflex.ServiceAuthToken"])
  return false unless object_type_validator.valid?(@object_type)
  status_validator = EnumAttributeValidator.new('String', ["Unknown", "Claiming", "Claimed", "FailedToClaim", "Revoking", "Revoked", "FailedToRevoke"])
  return false unless status_validator.valid?(@status)
  true && super
end