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):



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
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/database_management/models/external_asm.rb', line 160

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']
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

#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

#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

#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.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/database_management/models/external_asm.rb', line 91

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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'
    # 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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/oci/database_management/models/external_asm.rb', line 275

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
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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/oci/database_management/models/external_asm.rb', line 320

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


300
301
302
 
# File 'lib/oci/database_management/models/external_asm.rb', line 300

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



309
310
311
 
# File 'lib/oci/database_management/models/external_asm.rb', line 309

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].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



353
354
355
356
357
358
359
360
361
362
 
# File 'lib/oci/database_management/models/external_asm.rb', line 353

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



347
348
349
 
# File 'lib/oci/database_management/models/external_asm.rb', line 347

def to_s
  to_hash.to_s
end