Class: OCI::DatabaseManagement::Models::ExternalListener

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

Overview

The details of an external listener.

Constant Summary collapse

LISTENER_TYPE_ENUM = 
[
  LISTENER_TYPE_ASM = 'ASM'.freeze,
  LISTENER_TYPE_LOCAL = 'LOCAL'.freeze,
  LISTENER_TYPE_SCAN = 'SCAN'.freeze,
  LISTENER_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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 = {}) ⇒ ExternalListener

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
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
 
# File 'lib/oci/database_management/models/external_listener.rb', line 230

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

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

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

  self.external_db_home_id = attributes[:'externalDbHomeId'] if attributes[:'externalDbHomeId']

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

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

  self.listener_alias = attributes[:'listenerAlias'] if attributes[:'listenerAlias']

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

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

  self.listener_type = attributes[:'listenerType'] if attributes[:'listenerType']

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

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

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

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

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

  self.oracle_home = attributes[:'oracleHome'] if attributes[:'oracleHome']

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

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

  self.host_name = attributes[:'hostName'] if attributes[:'hostName']

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

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

  self.adr_home_directory = attributes[:'adrHomeDirectory'] if attributes[:'adrHomeDirectory']

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

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

  self.log_directory = attributes[:'logDirectory'] if attributes[:'logDirectory']

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

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

  self.trace_directory = attributes[:'traceDirectory'] if attributes[:'traceDirectory']

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_details ⇒ Hash<String, String>

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

Returns:

  • (Hash<String, String>) 


75
76
77
 
# File 'lib/oci/database_management/models/external_listener.rb', line 75

def additional_details
  @additional_details
end

#adr_home_directory ⇒ String

The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/database_management/models/external_listener.rb', line 99

def adr_home_directory
  @adr_home_directory
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/database_management/models/external_listener.rb', line 45

def compartment_id
  @compartment_id
end

#component_name ⇒ String

[Required] The name of the external listener.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/database_management/models/external_listener.rb', line 41

def component_name
  @component_name
end

#display_name ⇒ String

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

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/database_management/models/external_listener.rb', line 37

def display_name
  @display_name
end

#endpoints ⇒ Array<OCI::DatabaseManagement::Models::ExternalListenerEndpoint>

The list of protocol addresses the listener is configured to listen on.

Returns:



115
116
117
 
# File 'lib/oci/database_management/models/external_listener.rb', line 115

def endpoints
  @endpoints
end

#external_connector_id ⇒ String

The OCID of the external connector.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/database_management/models/external_listener.rb', line 53

def external_connector_id
  @external_connector_id
end

#external_db_home_id ⇒ String

The OCID of the external DB home.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/database_management/models/external_listener.rb', line 61

def external_db_home_id
  @external_db_home_id
end

#external_db_node_id ⇒ String

The OCID of the external DB node.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/database_management/models/external_listener.rb', line 57

def external_db_node_id
  @external_db_node_id
end

#external_db_system_id ⇒ String

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

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/database_management/models/external_listener.rb', line 49

def external_db_system_id
  @external_db_system_id
end

#host_name ⇒ String

The name of the host on which the external listener is running.

Returns:

  • (String) 


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

def host_name
  @host_name
end

#id ⇒ String

[Required] The OCID of the external listener.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/database_management/models/external_listener.rb', line 33

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/database_management/models/external_listener.rb', line 83

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/database_management/models/external_listener.rb', line 79

def lifecycle_state
  @lifecycle_state
end

#listener_alias ⇒ String

The listener alias.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/database_management/models/external_listener.rb', line 65

def listener_alias
  @listener_alias
end

#listener_ora_location ⇒ String

The location of the listener configuration file listener.ora.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/database_management/models/external_listener.rb', line 87

def listener_ora_location
  @listener_ora_location
end

#listener_type ⇒ String

The type of listener.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/database_management/models/external_listener.rb', line 69

def listener_type
  @listener_type
end

#log_directory ⇒ String

The destination directory of the listener log file.

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/database_management/models/external_listener.rb', line 103

def log_directory
  @log_directory
end

#oracle_home ⇒ String

The Oracle home location of the listener.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/database_management/models/external_listener.rb', line 91

def oracle_home
  @oracle_home
end

#serviced_asms ⇒ Array<OCI::DatabaseManagement::Models::ExternalServicedAsm>

The list of ASMs that are serviced by the listener.

Returns:



123
124
125
 
# File 'lib/oci/database_management/models/external_listener.rb', line 123

def serviced_asms
  @serviced_asms
end

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

The list of databases that are serviced by the listener.

Returns:



119
120
121
 
# File 'lib/oci/database_management/models/external_listener.rb', line 119

def serviced_databases
  @serviced_databases
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


127
128
129
 
# File 'lib/oci/database_management/models/external_listener.rb', line 127

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


131
132
133
 
# File 'lib/oci/database_management/models/external_listener.rb', line 131

def time_updated
  @time_updated
end

#trace_directory ⇒ String

The destination directory of the listener trace file.

Returns:

  • (String) 


107
108
109
 
# File 'lib/oci/database_management/models/external_listener.rb', line 107

def trace_directory
  @trace_directory
end

#version ⇒ String

The listener version.

Returns:

  • (String) 


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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/database_management/models/external_listener.rb', line 134

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',
    'external_db_node_id': :'externalDbNodeId',
    'external_db_home_id': :'externalDbHomeId',
    'listener_alias': :'listenerAlias',
    'listener_type': :'listenerType',
    'additional_details': :'additionalDetails',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'listener_ora_location': :'listenerOraLocation',
    'oracle_home': :'oracleHome',
    'host_name': :'hostName',
    'adr_home_directory': :'adrHomeDirectory',
    'log_directory': :'logDirectory',
    'trace_directory': :'traceDirectory',
    'version': :'version',
    'endpoints': :'endpoints',
    'serviced_databases': :'servicedDatabases',
    'serviced_asms': :'servicedAsms',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    'external_db_node_id': :'String',
    'external_db_home_id': :'String',
    'listener_alias': :'String',
    'listener_type': :'String',
    'additional_details': :'Hash<String, String>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'listener_ora_location': :'String',
    'oracle_home': :'String',
    'host_name': :'String',
    'adr_home_directory': :'String',
    'log_directory': :'String',
    'trace_directory': :'String',
    'version': :'String',
    'endpoints': :'Array<OCI::DatabaseManagement::Models::ExternalListenerEndpoint>',
    'serviced_databases': :'Array<OCI::DatabaseManagement::Models::ExternalListenerServicedDatabase>',
    'serviced_asms': :'Array<OCI::DatabaseManagement::Models::ExternalServicedAsm>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime'
    # 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



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

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 &&
    external_db_node_id == other.external_db_node_id &&
    external_db_home_id == other.external_db_home_id &&
    listener_alias == other.listener_alias &&
    listener_type == other.listener_type &&
    additional_details == other.additional_details &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    listener_ora_location == other.listener_ora_location &&
    oracle_home == other.oracle_home &&
    host_name == other.host_name &&
    adr_home_directory == other.adr_home_directory &&
    log_directory == other.log_directory &&
    trace_directory == other.trace_directory &&
    version == other.version &&
    endpoints == other.endpoints &&
    serviced_databases == other.serviced_databases &&
    serviced_asms == other.serviced_asms &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/oci/database_management/models/external_listener.rb', line 462

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


442
443
444
 
# File 'lib/oci/database_management/models/external_listener.rb', line 442

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



451
452
453
 
# File 'lib/oci/database_management/models/external_listener.rb', line 451

def hash
  [id, display_name, component_name, compartment_id, external_db_system_id, external_connector_id, external_db_node_id, external_db_home_id, listener_alias, listener_type, additional_details, lifecycle_state, lifecycle_details, listener_ora_location, oracle_home, host_name, adr_home_directory, log_directory, trace_directory, version, endpoints, serviced_databases, serviced_asms, time_created, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



495
496
497
498
499
500
501
502
503
504
 
# File 'lib/oci/database_management/models/external_listener.rb', line 495

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



489
490
491
 
# File 'lib/oci/database_management/models/external_listener.rb', line 489

def to_s
  to_hash.to_s
end