Class: IntersightClient::ApplianceDeviceCertificate

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

Overview

DeviceCertificate managed object stores the CA Certificate used by device connector and it allow tracks it renewal.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 149

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ca_certificate ⇒ Object

The base64 encoded certificate in PEM format.



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

def ca_certificate
  @ca_certificate
end

#ca_certificate_expiry_time ⇒ Object

The expiry datetime of new ca certificate which need to be applied on device connector.



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

def ca_certificate_expiry_time
  @ca_certificate_expiry_time
end

#certificate_renewal_expiry_time ⇒ Object

The date time allocated till cert renewal will be executed. This time used here will be based on cert renewal plan.



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

def certificate_renewal_expiry_time
  @certificate_renewal_expiry_time
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/appliance_device_certificate.rb', line 20

def class_id
  @class_id
end

#completed_phases ⇒ Object

Returns the value of attribute completed_phases.



34
35
36
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 34

def completed_phases
  @completed_phases
end

#configuration_mo_id ⇒ Object

The operation configuration MOId.



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

def configuration_mo_id
  @configuration_mo_id
end

#current_phase ⇒ Object

Returns the value of attribute current_phase.



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

def current_phase
  @current_phase
end

#end_time ⇒ Object

End date of the certificate renewal.



42
43
44
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 42

def end_time
  @end_time
end

#last_success_poll_time ⇒ Object

The last poll time when data collection was successfull. This time is used to collect data after this time in next cycle.



45
46
47
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 45

def last_success_poll_time
  @last_success_poll_time
end

#messages ⇒ Object

Returns the value of attribute messages.



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

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

def object_type
  @object_type
end

#start_time ⇒ Object

Start date of the certificate renewal.



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

def start_time
  @start_time
end

#status ⇒ Object

The status of ca certificate renewal.



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

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



102
103
104
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 102

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)



97
98
99
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 97

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.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 78

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'ca_certificate' => :'CaCertificate',
    :'ca_certificate_expiry_time' => :'CaCertificateExpiryTime',
    :'certificate_renewal_expiry_time' => :'CertificateRenewalExpiryTime',
    :'completed_phases' => :'CompletedPhases',
    :'configuration_mo_id' => :'ConfigurationMoId',
    :'current_phase' => :'CurrentPhase',
    :'end_time' => :'EndTime',
    :'last_success_poll_time' => :'LastSuccessPollTime',
    :'messages' => :'Messages',
    :'start_time' => :'StartTime',
    :'status' => :'Status'
  }
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



308
309
310
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 308

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



135
136
137
138
139
140
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 135

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



143
144
145
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 143

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
130
131
132
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 126

def self.openapi_nullable
  Set.new([
    :'completed_phases',
    :'current_phase',
    :'messages',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 107

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'ca_certificate' => :'String',
    :'ca_certificate_expiry_time' => :'Time',
    :'certificate_renewal_expiry_time' => :'Time',
    :'completed_phases' => :'Array<ApplianceCertRenewalPhase>',
    :'configuration_mo_id' => :'String',
    :'current_phase' => :'ApplianceCertRenewalPhase',
    :'end_time' => :'Time',
    :'last_success_poll_time' => :'Time',
    :'messages' => :'Array<String>',
    :'start_time' => :'Time',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 275

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      ca_certificate == o.ca_certificate &&
      ca_certificate_expiry_time == o.ca_certificate_expiry_time &&
      certificate_renewal_expiry_time == o.certificate_renewal_expiry_time &&
      completed_phases == o.completed_phases &&
      configuration_mo_id == o.configuration_mo_id &&
      current_phase == o.current_phase &&
      end_time == o.end_time &&
      last_success_poll_time == o.last_success_poll_time &&
      messages == o.messages &&
      start_time == o.start_time &&
      status == o.status && 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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 339

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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 410

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


295
296
297
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 295

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



301
302
303
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 301

def hash
  [class_id, object_type, ca_certificate, ca_certificate_expiry_time, certificate_renewal_expiry_time, completed_phases, configuration_mo_id, current_phase, end_time, last_success_poll_time, messages, start_time, status].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



228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 228

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



386
387
388
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 386

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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 392

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



380
381
382
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 380

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



243
244
245
246
247
248
249
250
251
 
# File 'lib/intersight_client/models/appliance_device_certificate.rb', line 243

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["appliance.DeviceCertificate"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["appliance.DeviceCertificate"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end