Class: OCI::DatabaseManagement::Models::ExternalListenerSummary

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

Overview

The summary of an external listener.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExternalListenerSummary

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

  • :external_db_node_id (String) —

    The value to assign to the #external_db_node_id property

  • :listener_type (String) —

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

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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
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
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 117

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

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 25

def compartment_id
  @compartment_id
end

#component_name ⇒ String

[Required] The name of the external listener.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 21

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) 


17
18
19
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 17

def display_name
  @display_name
end

#external_connector_id ⇒ String

The OCID of the external connector.

Returns:

  • (String) 


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

def external_connector_id
  @external_connector_id
end

#external_db_node_id ⇒ String

The OCID of the external DB node on which the listener is running.

Returns:

  • (String) 


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

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 member of.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 29

def external_db_system_id
  @external_db_system_id
end

#id ⇒ String

[Required] The OCID of the external listener.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 13

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#listener_type ⇒ String

The type of listener.

Returns:

  • (String) 


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

def listener_type
  @listener_type
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 60

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',
    'listener_type': :'listenerType',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 80

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',
    'listener_type': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    '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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 199

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 &&
    listener_type == other.listener_type &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 240

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


220
221
222
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 220

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



229
230
231
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 229

def hash
  [id, display_name, component_name, compartment_id, external_db_system_id, external_connector_id, external_db_node_id, listener_type, lifecycle_state, lifecycle_details, 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



273
274
275
276
277
278
279
280
281
282
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 273

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



267
268
269
 
# File 'lib/oci/database_management/models/external_listener_summary.rb', line 267

def to_s
  to_hash.to_s
end