Class: IntersightClient::HyperflexClusterBackupPolicyInventory

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

Overview

Response to Backup Policy requests and queries.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 167

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#action ⇒ Object

Validate, Deploy, Prepare, Commit, or Abort the Backup Policy. Allowed values are "VALIDATE", "DEPLOY", "PREPARE", "COMMIT", "ABORT". * ‘VALIDATE` - Check for problems in policy request without deploying. * `DEPLOY` - Remove the policy. Only allowed when cleanup field is true. * `PREPARE` - Prepare the policy for subsequent "COMMIT" or "ABORT". Only allowed when cleanup field is false. * `COMMIT` - Commit the prepared policy. Only allowed when cleanup field is false. * `ABORT` - Abort the prepared policy. Only allowed when cleanup field is false.



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

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

def class_id
  @class_id
end

#cleanup ⇒ Object

If true, remove the policy. Otherwise proceed with the specified policy action.



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

def cleanup
  @cleanup
end

#is_source ⇒ Object

Indicates if the HyperFlex Cluster is the source cluster or the target cluster. When set to true, the HyperFlex Cluster is the source for VM backups. When set to false, the HyperFlex Cluster is the target cluster where VM backups are saved.



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

def is_source
  @is_source
end

#job_details ⇒ Object

Details from associated HyperFlex job execution.



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

def job_details
  @job_details
end

#job_exception_message ⇒ Object

Job Exception message from associated HyperFlex job execution.



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

def job_exception_message
  @job_exception_message
end

#job_id ⇒ Object

Job ID of associated HyperFlex job.



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

def job_id
  @job_id
end

#job_state ⇒ Object

State of the associated HyperFlex job. When present possible values are "RUNNING", "COMPLETED" or "EXCEPTION". * ‘RUNNING` - HyperFlex policy job is currently "RUNNING". * `COMPLETED` - HyperFlex policy job completed successfully. * `EXCEPTION` - HyperFlex policy job failed.



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

def job_state
  @job_state
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_cluster_backup_policy_inventory.rb', line 23

def object_type
  @object_type
end

#policy_moid ⇒ Object

Intersight HyperFlex Cluster Backup Policy MOID.



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

def policy_moid
  @policy_moid
end

#request_id ⇒ Object

Unique request ID allowing retry of the same logical request following a transient communication failure.



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

def request_id
  @request_id
end

#settings ⇒ Object

Returns the value of attribute settings.



52
53
54
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 52

def settings
  @settings
end

#source_uuid ⇒ Object

UUID of the source HyperFlex Cluster.



55
56
57
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 55

def source_uuid
  @source_uuid
end

#src_cluster ⇒ Object

Returns the value of attribute src_cluster.



63
64
65
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 63

def src_cluster
  @src_cluster
end

#target_uuid ⇒ Object

UUID of the target HyperFlex Cluster.



58
59
60
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 58

def target_uuid
  @target_uuid
end

#tgt_cluster ⇒ Object

Returns the value of attribute tgt_cluster.



65
66
67
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 65

def tgt_cluster
  @tgt_cluster
end

#version ⇒ Object

Version of the Backup Policy.



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

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



118
119
120
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 118

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)



113
114
115
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 113

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.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 90

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'action' => :'Action',
    :'cleanup' => :'Cleanup',
    :'is_source' => :'IsSource',
    :'job_details' => :'JobDetails',
    :'job_exception_message' => :'JobExceptionMessage',
    :'job_id' => :'JobId',
    :'job_state' => :'JobState',
    :'policy_moid' => :'PolicyMoid',
    :'request_id' => :'RequestId',
    :'settings' => :'Settings',
    :'source_uuid' => :'SourceUuid',
    :'target_uuid' => :'TargetUuid',
    :'version' => :'Version',
    :'src_cluster' => :'SrcCluster',
    :'tgt_cluster' => :'TgtCluster'
  }
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



370
371
372
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 370

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



153
154
155
156
157
158
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 153

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



161
162
163
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 161

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



146
147
148
149
150
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 146

def self.openapi_nullable
  Set.new([
    :'settings',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 123

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'action' => :'String',
    :'cleanup' => :'Boolean',
    :'is_source' => :'Boolean',
    :'job_details' => :'String',
    :'job_exception_message' => :'String',
    :'job_id' => :'String',
    :'job_state' => :'String',
    :'policy_moid' => :'String',
    :'request_id' => :'String',
    :'settings' => :'HyperflexBackupPolicySettings',
    :'source_uuid' => :'String',
    :'target_uuid' => :'String',
    :'version' => :'Integer',
    :'src_cluster' => :'HyperflexClusterRelationship',
    :'tgt_cluster' => :'HyperflexClusterRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 333

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      action == o.action &&
      cleanup == o.cleanup &&
      is_source == o.is_source &&
      job_details == o.job_details &&
      job_exception_message == o.job_exception_message &&
      job_id == o.job_id &&
      job_state == o.job_state &&
      policy_moid == o.policy_moid &&
      request_id == o.request_id &&
      settings == o.settings &&
      source_uuid == o.source_uuid &&
      target_uuid == o.target_uuid &&
      version == o.version &&
      src_cluster == o.src_cluster &&
      tgt_cluster == o.tgt_cluster && 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



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 401

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



472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 472

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



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 377

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


357
358
359
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 357

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



363
364
365
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 363

def hash
  [class_id, object_type, action, cleanup, is_source, job_details, job_exception_message, job_id, job_state, policy_moid, request_id, settings, source_uuid, target_uuid, version, src_cluster, tgt_cluster].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



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

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



448
449
450
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 448

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



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

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



442
443
444
 
# File 'lib/intersight_client/models/hyperflex_cluster_backup_policy_inventory.rb', line 442

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



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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hyperflex.ClusterBackupPolicyInventory"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hyperflex.ClusterBackupPolicyInventory"])
  return false unless object_type_validator.valid?(@object_type)
  action_validator = EnumAttributeValidator.new('String', ["VALIDATE", "DEPLOY", "PREPARE", "COMMIT", "ABORT"])
  return false unless action_validator.valid?(@action)
  job_state_validator = EnumAttributeValidator.new('String', ["RUNNING", "COMPLETED", "EXCEPTION"])
  return false unless job_state_validator.valid?(@job_state)
  true && super
end