Class: OCI::DatabaseManagement::Models::ExternalAsm

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/external_asm.rb

Overview

The details of an external ASM.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_NOT_CONNECTED = 'NOT_CONNECTED'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.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 = {}) ⇒ ExternalAsm

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :component_name (String) —

    The value to assign to the #component_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :external_db_system_id (String) —

    The value to assign to the #external_db_system_id property

  • :external_connector_id (String) —

    The value to assign to the #external_connector_id property

  • :grid_home (String) —

    The value to assign to the #grid_home property

  • :is_cluster (BOOLEAN) —

    The value to assign to the #is_cluster property

  • :is_flex_enabled (BOOLEAN) —

    The value to assign to the #is_flex_enabled property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :serviced_databases (Array<OCI::DatabaseManagement::Models::ExternalAsmServicedDatabase>) —

    The value to assign to the #serviced_databases property

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

    The value to assign to the #additional_details 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

  • :version (String) —

    The value to assign to the #version 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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/oci/database_management/models/external_asm.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.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.component_name = attributes[:'componentName'] if attributes[:'componentName']

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

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

  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.external_db_system_id = attributes[:'externalDbSystemId'] if attributes[:'externalDbSystemId']

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

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

  self.external_connector_id = attributes[:'externalConnectorId'] if attributes[:'externalConnectorId']

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

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

  self.grid_home = attributes[:'gridHome'] if attributes[:'gridHome']

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

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

  self.is_cluster = attributes[:'isCluster'] unless attributes[:'isCluster'].nil?

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

  self.is_cluster = attributes[:'is_cluster'] unless attributes[:'is_cluster'].nil?

  self.is_flex_enabled = attributes[:'isFlexEnabled'] unless attributes[:'isFlexEnabled'].nil?

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

  self.is_flex_enabled = attributes[:'is_flex_enabled'] unless attributes[:'is_flex_enabled'].nil?

  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.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.serviced_databases = attributes[:'servicedDatabases'] if attributes[:'servicedDatabases']

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

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

  self.additional_details = attributes[:'additionalDetails'] if attributes[:'additionalDetails']

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

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

  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.version = attributes[:'version'] if attributes[:'version']

  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

#additional_details ⇒ Hash<String, String>

The additional details of the external ASM defined in {\"key\": \"value\"} format. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


76
77
78
 
# File 'lib/oci/database_management/models/external_asm.rb', line 76

def additional_details
  @additional_details
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database_management/models/external_asm.rb', line 38

def compartment_id
  @compartment_id
end

#component_name ⇒ String

[Required] The name of the external ASM.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/database_management/models/external_asm.rb', line 34

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


102
103
104
 
# File 'lib/oci/database_management/models/external_asm.rb', line 102

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The user-friendly name for the external ASM. The name does not have to be unique.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/database_management/models/external_asm.rb', line 30

def display_name
  @display_name
end

#external_connector_id ⇒ String

The OCID of the external connector.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database_management/models/external_asm.rb', line 46

def external_connector_id
  @external_connector_id
end

#external_db_system_id ⇒ String

[Required] The OCID of the external DB system that the ASM is a part of.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database_management/models/external_asm.rb', line 42

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


95
96
97
 
# File 'lib/oci/database_management/models/external_asm.rb', line 95

def freeform_tags
  @freeform_tags
end

#grid_home ⇒ String

The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database_management/models/external_asm.rb', line 50

def grid_home
  @grid_home
end

#id ⇒ String

[Required] The OCID of the external ASM.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database_management/models/external_asm.rb', line 26

def id
  @id
end

#is_cluster ⇒ BOOLEAN

Indicates whether the ASM is a cluster ASM or not.

Returns:

  • (BOOLEAN) 


54
55
56
 
# File 'lib/oci/database_management/models/external_asm.rb', line 54

def is_cluster
  @is_cluster
end

#is_flex_enabled ⇒ BOOLEAN

Indicates whether Oracle Flex ASM is enabled or not.

Returns:

  • (BOOLEAN) 


58
59
60
 
# File 'lib/oci/database_management/models/external_asm.rb', line 58

def is_flex_enabled
  @is_flex_enabled
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/database_management/models/external_asm.rb', line 66

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the external ASM.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/database_management/models/external_asm.rb', line 62

def lifecycle_state
  @lifecycle_state
end

#serviced_databases ⇒ Array<OCI::DatabaseManagement::Models::ExternalAsmServicedDatabase>

The list of databases that are serviced by the ASM.

Returns:



70
71
72
 
# File 'lib/oci/database_management/models/external_asm.rb', line 70

def serviced_databases
  @serviced_databases
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


111
112
113
 
# File 'lib/oci/database_management/models/external_asm.rb', line 111

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the external ASM was created.

Returns:

  • (DateTime) 


80
81
82
 
# File 'lib/oci/database_management/models/external_asm.rb', line 80

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the external ASM was last updated.

Returns:

  • (DateTime) 


84
85
86
 
# File 'lib/oci/database_management/models/external_asm.rb', line 84

def time_updated
  @time_updated
end

#version ⇒ String

The ASM version.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/database_management/models/external_asm.rb', line 88

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/database_management/models/external_asm.rb', line 114

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'component_name': :'componentName',
    'compartment_id': :'compartmentId',
    'external_db_system_id': :'externalDbSystemId',
    'external_connector_id': :'externalConnectorId',
    'grid_home': :'gridHome',
    'is_cluster': :'isCluster',
    'is_flex_enabled': :'isFlexEnabled',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'serviced_databases': :'servicedDatabases',
    'additional_details': :'additionalDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'version': :'version',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/database_management/models/external_asm.rb', line 141

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'component_name': :'String',
    'compartment_id': :'String',
    'external_db_system_id': :'String',
    'external_connector_id': :'String',
    'grid_home': :'String',
    'is_cluster': :'BOOLEAN',
    'is_flex_enabled': :'BOOLEAN',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'serviced_databases': :'Array<OCI::DatabaseManagement::Models::ExternalAsmServicedDatabase>',
    'additional_details': :'Hash<String, String>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'version': :'String',
    '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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/oci/database_management/models/external_asm.rb', line 325

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    component_name == other.component_name &&
    compartment_id == other.compartment_id &&
    external_db_system_id == other.external_db_system_id &&
    external_connector_id == other.external_connector_id &&
    grid_home == other.grid_home &&
    is_cluster == other.is_cluster &&
    is_flex_enabled == other.is_flex_enabled &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    serviced_databases == other.serviced_databases &&
    additional_details == other.additional_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    version == other.version &&
    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



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/oci/database_management/models/external_asm.rb', line 373

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


353
354
355
 
# File 'lib/oci/database_management/models/external_asm.rb', line 353

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



362
363
364
 
# File 'lib/oci/database_management/models/external_asm.rb', line 362

def hash
  [id, display_name, component_name, compartment_id, external_db_system_id, external_connector_id, grid_home, is_cluster, is_flex_enabled, lifecycle_state, lifecycle_details, serviced_databases, additional_details, time_created, time_updated, version, 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



406
407
408
409
410
411
412
413
414
415
 
# File 'lib/oci/database_management/models/external_asm.rb', line 406

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



400
401
402
 
# File 'lib/oci/database_management/models/external_asm.rb', line 400

def to_s
  to_hash.to_s
end