Class: OCI::DatabaseManagement::Models::DiscoveredExternalListener

Inherits:
DiscoveredExternalDbSystemComponent show all
Defined in:
lib/oci/database_management/models/discovered_external_listener.rb

Overview

The details of an Oracle listener discovered in an external DB system discovery run.

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

Constants inherited from DiscoveredExternalDbSystemComponent

OCI::DatabaseManagement::Models::DiscoveredExternalDbSystemComponent::COMPONENT_TYPE_ENUM, OCI::DatabaseManagement::Models::DiscoveredExternalDbSystemComponent::STATUS_ENUM

Instance Attribute Summary collapse

Attributes inherited from DiscoveredExternalDbSystemComponent

#associated_components, #component_id, #component_name, #component_type, #display_name, #is_selected_for_monitoring, #resource_id, #status

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DiscoveredExternalDbSystemComponent

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DiscoveredExternalListener

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

  attributes['componentType'] = 'LISTENER'

  super(attributes)

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

  self.db_node_name = attributes[:'dbNodeName'] if attributes[:'dbNodeName']

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

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

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

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

Instance Attribute Details

#adr_home_directory ⇒ String

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

Returns:

  • (String) 


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

def adr_home_directory
  @adr_home_directory
end

#connector ⇒ OCI::DatabaseManagement::Models::ExternalDbSystemDiscoveryConnector

Returns:



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

def connector
  @connector
end

#db_node_name ⇒ String

The name of the DB node.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/database_management/models/discovered_external_listener.rb', line 22

def db_node_name
  @db_node_name
end

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

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

Returns:



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

def endpoints
  @endpoints
end

#host_name ⇒ String

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

Returns:

  • (String) 


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

def host_name
  @host_name
end

#listener_alias ⇒ String

The listener alias.

Returns:

  • (String) 


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

def listener_alias
  @listener_alias
end

#listener_type ⇒ String

The type of listener.

Returns:

  • (String) 


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

def listener_type
  @listener_type
end

#log_directory ⇒ String

The destination directory of the listener log file.

Returns:

  • (String) 


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

def log_directory
  @log_directory
end

#oracle_home ⇒ String

The Oracle home location of the listener.

Returns:

  • (String) 


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

def oracle_home
  @oracle_home
end

#trace_directory ⇒ String

The destination directory of the listener trace file.

Returns:

  • (String) 


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

def trace_directory
  @trace_directory
end

#version ⇒ String

The listener version.

Returns:

  • (String) 


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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/database_management/models/discovered_external_listener.rb', line 64

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'component_id': :'componentId',
    'display_name': :'displayName',
    'component_name': :'componentName',
    'component_type': :'componentType',
    'resource_id': :'resourceId',
    'is_selected_for_monitoring': :'isSelectedForMonitoring',
    'status': :'status',
    'associated_components': :'associatedComponents',
    'db_node_name': :'dbNodeName',
    'oracle_home': :'oracleHome',
    'listener_alias': :'listenerAlias',
    'adr_home_directory': :'adrHomeDirectory',
    'log_directory': :'logDirectory',
    'trace_directory': :'traceDirectory',
    'version': :'version',
    'listener_type': :'listenerType',
    'host_name': :'hostName',
    'endpoints': :'endpoints',
    'connector': :'connector'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'component_id': :'String',
    'display_name': :'String',
    'component_name': :'String',
    'component_type': :'String',
    'resource_id': :'String',
    'is_selected_for_monitoring': :'BOOLEAN',
    'status': :'String',
    'associated_components': :'Array<OCI::DatabaseManagement::Models::AssociatedComponent>',
    'db_node_name': :'String',
    'oracle_home': :'String',
    'listener_alias': :'String',
    'adr_home_directory': :'String',
    'log_directory': :'String',
    'trace_directory': :'String',
    'version': :'String',
    'listener_type': :'String',
    'host_name': :'String',
    'endpoints': :'Array<OCI::DatabaseManagement::Models::ExternalListenerEndpoint>',
    'connector': :'OCI::DatabaseManagement::Models::ExternalDbSystemDiscoveryConnector'
    # 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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/database_management/models/discovered_external_listener.rb', line 226

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

  self.class == other.class &&
    component_id == other.component_id &&
    display_name == other.display_name &&
    component_name == other.component_name &&
    component_type == other.component_type &&
    resource_id == other.resource_id &&
    is_selected_for_monitoring == other.is_selected_for_monitoring &&
    status == other.status &&
    associated_components == other.associated_components &&
    db_node_name == other.db_node_name &&
    oracle_home == other.oracle_home &&
    listener_alias == other.listener_alias &&
    adr_home_directory == other.adr_home_directory &&
    log_directory == other.log_directory &&
    trace_directory == other.trace_directory &&
    version == other.version &&
    listener_type == other.listener_type &&
    host_name == other.host_name &&
    endpoints == other.endpoints &&
    connector == other.connector
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



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

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


254
255
256
 
# File 'lib/oci/database_management/models/discovered_external_listener.rb', line 254

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



263
264
265
 
# File 'lib/oci/database_management/models/discovered_external_listener.rb', line 263

def hash
  [component_id, display_name, component_name, component_type, resource_id, is_selected_for_monitoring, status, associated_components, db_node_name, oracle_home, listener_alias, adr_home_directory, log_directory, trace_directory, version, listener_type, host_name, endpoints, connector].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



307
308
309
310
311
312
313
314
315
316
 
# File 'lib/oci/database_management/models/discovered_external_listener.rb', line 307

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



301
302
303
 
# File 'lib/oci/database_management/models/discovered_external_listener.rb', line 301

def to_s
  to_hash.to_s
end