Class: OCI::Ocvp::Models::DatastoreCluster

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ocvp/models/datastore_cluster.rb

Overview

An Oracle Cloud VMware Solution Datastore Cluster for software-defined data center.

The Datastore Cluster combines multiple datastores into a single datastore cluster.

Constant Summary collapse

DATASTORE_CLUSTER_TYPE_ENUM = 
[
  DATASTORE_CLUSTER_TYPE_MANAGEMENT = 'MANAGEMENT'.freeze,
  DATASTORE_CLUSTER_TYPE_WORKLOAD = 'WORKLOAD'.freeze,
  DATASTORE_CLUSTER_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DatastoreCluster

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :datastore_ids (Array<String>) —

    The value to assign to the #datastore_ids property

  • :cluster_id (String) —

    The value to assign to the #cluster_id property

  • :sddc_id (String) —

    The value to assign to the #sddc_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :esxi_host_ids (Array<String>) —

    The value to assign to the #esxi_host_ids property

  • :datastore_cluster_type (String) —

    The value to assign to the #datastore_cluster_type property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :capacity_in_gbs (Float) —

    The value to assign to the #capacity_in_gbs property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 192

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.datastore_ids = attributes[:'datastoreIds'] if attributes[:'datastoreIds']

  raise 'You cannot provide both :datastoreIds and :datastore_ids' if attributes.key?(:'datastoreIds') && attributes.key?(:'datastore_ids')

  self.datastore_ids = attributes[:'datastore_ids'] if attributes[:'datastore_ids']

  self.cluster_id = attributes[:'clusterId'] if attributes[:'clusterId']

  raise 'You cannot provide both :clusterId and :cluster_id' if attributes.key?(:'clusterId') && attributes.key?(:'cluster_id')

  self.cluster_id = attributes[:'cluster_id'] if attributes[:'cluster_id']

  self.sddc_id = attributes[:'sddcId'] if attributes[:'sddcId']

  raise 'You cannot provide both :sddcId and :sddc_id' if attributes.key?(:'sddcId') && attributes.key?(:'sddc_id')

  self.sddc_id = attributes[:'sddc_id'] if attributes[:'sddc_id']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.esxi_host_ids = attributes[:'esxiHostIds'] if attributes[:'esxiHostIds']

  raise 'You cannot provide both :esxiHostIds and :esxi_host_ids' if attributes.key?(:'esxiHostIds') && attributes.key?(:'esxi_host_ids')

  self.esxi_host_ids = attributes[:'esxi_host_ids'] if attributes[:'esxi_host_ids']

  self.datastore_cluster_type = attributes[:'datastoreClusterType'] if attributes[:'datastoreClusterType']

  raise 'You cannot provide both :datastoreClusterType and :datastore_cluster_type' if attributes.key?(:'datastoreClusterType') && attributes.key?(:'datastore_cluster_type')

  self.datastore_cluster_type = attributes[:'datastore_cluster_type'] if attributes[:'datastore_cluster_type']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

  raise 'You cannot provide both :availabilityDomain and :availability_domain' if attributes.key?(:'availabilityDomain') && attributes.key?(:'availability_domain')

  self.availability_domain = attributes[:'availability_domain'] if attributes[:'availability_domain']

  self.capacity_in_gbs = attributes[:'capacityInGBs'] if attributes[:'capacityInGBs']

  raise 'You cannot provide both :capacityInGBs and :capacity_in_gbs' if attributes.key?(:'capacityInGBs') && attributes.key?(:'capacity_in_gbs')

  self.capacity_in_gbs = attributes[:'capacity_in_gbs'] if attributes[:'capacity_in_gbs']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#availability_domain ⇒ String

[Required] The availability domain of the Datastore Cluster.

Returns:

  • (String) 


94
95
96
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 94

def availability_domain
  @availability_domain
end

#capacity_in_gbs ⇒ Float

Total size of all datastores associated with the datastore cluster in GB.

Returns:

  • (Float) 


98
99
100
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 98

def capacity_in_gbs
  @capacity_in_gbs
end

#cluster_id ⇒ String

The OCID of the VMware Cluster that Datastore cluster is attached to.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 44

def cluster_id
  @cluster_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the Datastore.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 55

def compartment_id
  @compartment_id
end

#datastore_cluster_type ⇒ String

[Required] Type of the datastore cluster.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 72

def datastore_cluster_type
  @datastore_cluster_type
end

#datastore_ids ⇒ Array<String>

[Required] The OCIDs of the Datastores that belong to the Datastore Cluster

Returns:

  • (Array<String>) 


39
40
41
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 39

def datastore_ids
  @datastore_ids
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


114
115
116
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 114

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A descriptive name for the Datastore Cluster. It must be unique within a SDDC, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 62

def display_name
  @display_name
end

#esxi_host_ids ⇒ Array<String>

The OCIDs of the ESXi hosts to attach the datastore to. All ESXi hosts must belong to the same VMware cluster.

Returns:

  • (Array<String>) 


68
69
70
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 68

def esxi_host_ids
  @esxi_host_ids
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


106
107
108
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 106

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Datastore cluster.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 34

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the Datastore Cluster.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 89

def lifecycle_state
  @lifecycle_state
end

#sddc_id ⇒ String

The OCID of the SDDC that Datastore cluster is associated with.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 49

def sddc_id
  @sddc_id
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


120
121
122
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 120

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the Datastore Cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


79
80
81
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 79

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the Datastore Cluster was updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


85
86
87
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 85

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'datastore_ids': :'datastoreIds',
    'cluster_id': :'clusterId',
    'sddc_id': :'sddcId',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'esxi_host_ids': :'esxiHostIds',
    'datastore_cluster_type': :'datastoreClusterType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'availability_domain': :'availabilityDomain',
    'capacity_in_gbs': :'capacityInGBs',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 147

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'datastore_ids': :'Array<String>',
    'cluster_id': :'String',
    'sddc_id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'esxi_host_ids': :'Array<String>',
    'datastore_cluster_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'availability_domain': :'String',
    'capacity_in_gbs': :'Float',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 324

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    datastore_ids == other.datastore_ids &&
    cluster_id == other.cluster_id &&
    sddc_id == other.sddc_id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    esxi_host_ids == other.esxi_host_ids &&
    datastore_cluster_type == other.datastore_cluster_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    availability_domain == other.availability_domain &&
    capacity_in_gbs == other.capacity_in_gbs &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 369

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


349
350
351
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 349

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



358
359
360
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 358

def hash
  [id, datastore_ids, cluster_id, sddc_id, compartment_id, display_name, esxi_host_ids, datastore_cluster_type, time_created, time_updated, lifecycle_state, availability_domain, capacity_in_gbs, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



402
403
404
405
406
407
408
409
410
411
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 402

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



396
397
398
 
# File 'lib/oci/ocvp/models/datastore_cluster.rb', line 396

def to_s
  to_hash.to_s
end