Class: IntersightClient::LicenseLicenseInfo

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

Overview

License state information for a specific license entitlement. Essentials license entitlement is supported currently. licenseState attribute is used for license enforcement. When license state is one of TrialPeriod, Compliance, or OutOfCompliance, the feature set defined for the license entitlement is granted to the customer.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
184
185
186
187
188
189
190
191
192
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
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/intersight_client/models/license_license_info.rb', line 158

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::LicenseLicenseInfo` 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 = 'license.LicenseInfo'
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_license_data ⇒ Object

Returns the value of attribute account_license_data.



61
62
63
 
# File 'lib/intersight_client/models/license_license_info.rb', line 61

def 
  @account_license_data
end

#active_admin ⇒ Object

The license administrative state. Set this property to ‘true’ to activate the license entitlements.



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

def active_admin
  @active_admin
end

#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/license_license_info.rb', line 20

def class_id
  @class_id
end

#days_left ⇒ Object

The number of days left for licenseState to stay in TrialPeriod or OutOfCompliance state.



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

def days_left
  @days_left
end

#end_time ⇒ Object

The date and time when the trial period expires. The value of the ‘endTime’ property is set when the account enters the TrialPeriod or OutOfCompliance state.



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

def end_time
  @end_time
end

#enforce_mode ⇒ Object

The entitlement mode reported by Cisco Smart Software Manager.



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

def enforce_mode
  @enforce_mode
end

#error_desc ⇒ Object

The detailed error message when there is any error related to this licensing entitlement.



38
39
40
 
# File 'lib/intersight_client/models/license_license_info.rb', line 38

def error_desc
  @error_desc
end

#evaluation_period ⇒ Object

The default Trial or Grace period customer is entitled to.



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

def evaluation_period
  @evaluation_period
end

#extra_evaluation ⇒ Object

The number of days the trial Trial or Grace period is extended. The trial or grace period can be extended once.



44
45
46
 
# File 'lib/intersight_client/models/license_license_info.rb', line 44

def extra_evaluation
  @extra_evaluation
end

#license_count ⇒ Object

The total number of devices claimed in the Intersight account.



47
48
49
 
# File 'lib/intersight_client/models/license_license_info.rb', line 47

def license_count
  @license_count
end

#license_state ⇒ Object

The license state defined by Intersight. The value may be one of NotLicensed, TrialPeriod, OutOfCompliance, Compliance, GraceExpired, or TrialExpired. * NotLicensed - The license token is neither activated nor registered. * GraceExpired - The license grace period has expired. * TrialPeriod - The 90 days of trial period. * OutOfCompliance - The license is out of compliance. * Compliance - The license is in compliance. * TrialExpired - The trial period of 90 days has expired.



50
51
52
 
# File 'lib/intersight_client/models/license_license_info.rb', line 50

def license_state
  @license_state
end

#license_type ⇒ Object

The name of the Intersight license entitlement. For example, this property may be set to ‘Essential’. * Base - Base as a License type. It is default license type. * Essential - Essential as a License type. * Standard - Standard as a License type. * Advantage - Advantage as a License type. * Premier - Premier as a License type. * IWO-Essential - IWO-Essential as a License type. * IWO-Advantage - IWO-Advantage as a License type. * IWO-Premier - IWO-Premier as a License type.



53
54
55
 
# File 'lib/intersight_client/models/license_license_info.rb', line 53

def license_type
  @license_type
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/license_license_info.rb', line 23

def object_type
  @object_type
end

#start_time ⇒ Object

The date and time when the licenseState entered the TrialPeriod or OutOfCompliance state.



56
57
58
 
# File 'lib/intersight_client/models/license_license_info.rb', line 56

def start_time
  @start_time
end

#trial_admin ⇒ Object

The administrative state of the trial license. When the LicenseState is set to ‘NotLicensed’, ‘trialAdmin’ can be set to true to start the trial period, i.e. licenseState is set to be TrialPeriod.



59
60
61
 
# File 'lib/intersight_client/models/license_license_info.rb', line 59

def trial_admin
  @trial_admin
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)



112
113
114
 
# File 'lib/intersight_client/models/license_license_info.rb', line 112

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)



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

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.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/intersight_client/models/license_license_info.rb', line 86

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'active_admin' => :'ActiveAdmin',
    :'days_left' => :'DaysLeft',
    :'end_time' => :'EndTime',
    :'enforce_mode' => :'EnforceMode',
    :'error_desc' => :'ErrorDesc',
    :'evaluation_period' => :'EvaluationPeriod',
    :'extra_evaluation' => :'ExtraEvaluation',
    :'license_count' => :'LicenseCount',
    :'license_state' => :'LicenseState',
    :'license_type' => :'LicenseType',
    :'start_time' => :'StartTime',
    :'trial_admin' => :'TrialAdmin',
    :'account_license_data' => :'AccountLicenseData'
  }
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



351
352
353
 
# File 'lib/intersight_client/models/license_license_info.rb', line 351

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



144
145
146
147
148
149
 
# File 'lib/intersight_client/models/license_license_info.rb', line 144

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



152
153
154
 
# File 'lib/intersight_client/models/license_license_info.rb', line 152

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



138
139
140
141
 
# File 'lib/intersight_client/models/license_license_info.rb', line 138

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

.openapi_types ⇒ Object

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/intersight_client/models/license_license_info.rb', line 117

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'active_admin' => :'Boolean',
    :'days_left' => :'Integer',
    :'end_time' => :'Time',
    :'enforce_mode' => :'String',
    :'error_desc' => :'String',
    :'evaluation_period' => :'Integer',
    :'extra_evaluation' => :'Integer',
    :'license_count' => :'Integer',
    :'license_state' => :'String',
    :'license_type' => :'String',
    :'start_time' => :'Time',
    :'trial_admin' => :'Boolean',
    :'account_license_data' => :'LicenseAccountLicenseDataRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/intersight_client/models/license_license_info.rb', line 316

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      active_admin == o.active_admin &&
      days_left == o.days_left &&
      end_time == o.end_time &&
      enforce_mode == o.enforce_mode &&
      error_desc == o.error_desc &&
      evaluation_period == o.evaluation_period &&
      extra_evaluation == o.extra_evaluation &&
      license_count == o.license_count &&
      license_state == o.license_state &&
      license_type == o.license_type &&
      start_time == o.start_time &&
      trial_admin == o.trial_admin &&
       == o. && super(o)
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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/intersight_client/models/license_license_info.rb', line 382

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:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/intersight_client/models/license_license_info.rb', line 453

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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/intersight_client/models/license_license_info.rb', line 358

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


338
339
340
 
# File 'lib/intersight_client/models/license_license_info.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



344
345
346
 
# File 'lib/intersight_client/models/license_license_info.rb', line 344

def hash
  [class_id, object_type, active_admin, days_left, end_time, enforce_mode, error_desc, evaluation_period, extra_evaluation, license_count, license_state, license_type, start_time, trial_admin, ].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



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

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:

  • (Hash) —

    Returns the object in the form of hash



429
430
431
 
# File 'lib/intersight_client/models/license_license_info.rb', line 429

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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/intersight_client/models/license_license_info.rb', line 435

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



423
424
425
 
# File 'lib/intersight_client/models/license_license_info.rb', line 423

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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/intersight_client/models/license_license_info.rb', line 260

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["license.LicenseInfo"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["license.LicenseInfo"])
  return false unless object_type_validator.valid?(@object_type)
  license_state_validator = EnumAttributeValidator.new('String', ["NotLicensed", "GraceExpired", "TrialPeriod", "OutOfCompliance", "Compliance", "TrialExpired"])
  return false unless license_state_validator.valid?(@license_state)
  license_type_validator = EnumAttributeValidator.new('String', ["Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier"])
  return false unless license_type_validator.valid?(@license_type)
  true && super
end