Class: OCI::DatabaseManagement::Models::ExternalDbSystemConnector

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

Overview

The details of an external DB system connector. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

ExternalDbSystemMacsConnector

Constant Summary collapse

CONNECTOR_TYPE_ENUM = 
[
  CONNECTOR_TYPE_MACS = 'MACS'.freeze,
  CONNECTOR_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 = {}) ⇒ ExternalDbSystemConnector

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 153

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

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

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

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

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

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

  self.connection_failure_message = attributes[:'connectionFailureMessage'] if attributes[:'connectionFailureMessage']

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

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

  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_connection_status_last_updated = attributes[:'timeConnectionStatusLastUpdated'] if attributes[:'timeConnectionStatusLastUpdated']

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

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

  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) 


44
45
46
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 44

def compartment_id
  @compartment_id
end

#connection_failure_message ⇒ String

The error message indicating the reason for connection failure or null if the connection was successful.

Returns:

  • (String) 


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

def connection_failure_message
  @connection_failure_message
end

#connection_status ⇒ String

The status of connectivity to the external DB system component.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 52

def connection_status
  @connection_status
end

#connector_type ⇒ String

[Required] The type of connector.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 32

def connector_type
  @connector_type
end

#display_name ⇒ String

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

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 40

def display_name
  @display_name
end

#external_db_system_id ⇒ String

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

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 48

def external_db_system_id
  @external_db_system_id
end

#id ⇒ String

[Required] The OCID of the external DB system connector.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 36

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the external DB system connector.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#time_connection_status_last_updated ⇒ DateTime

The date and time the connectionStatus of the external DB system connector was last updated.

Returns:

  • (DateTime) 


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

def time_connection_status_last_updated
  @time_connection_status_last_updated
end

#time_created ⇒ DateTime

[Required] The date and time the external DB system connector was created.

Returns:

  • (DateTime) 


74
75
76
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 74

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the external DB system connector was last updated.

Returns:

  • (DateTime) 


78
79
80
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 78

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connector_type': :'connectorType',
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'external_db_system_id': :'externalDbSystemId',
    'connection_status': :'connectionStatus',
    'connection_failure_message': :'connectionFailureMessage',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_connection_status_last_updated': :'timeConnectionStatusLastUpdated',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



125
126
127
128
129
130
131
132
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 125

def self.get_subtype(object_hash)
  type = object_hash[:'connectorType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DatabaseManagement::Models::ExternalDbSystemMacsConnector' if type == 'MACS'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DatabaseManagement::Models::ExternalDbSystemConnector'
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 101

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connector_type': :'String',
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'external_db_system_id': :'String',
    'connection_status': :'String',
    'connection_failure_message': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_connection_status_last_updated': :'DateTime',
    '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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 261

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

  self.class == other.class &&
    connector_type == other.connector_type &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    external_db_system_id == other.external_db_system_id &&
    connection_status == other.connection_status &&
    connection_failure_message == other.connection_failure_message &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_connection_status_last_updated == other.time_connection_status_last_updated &&
    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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 302

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


282
283
284
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 282

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



291
292
293
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 291

def hash
  [connector_type, id, display_name, compartment_id, external_db_system_id, connection_status, connection_failure_message, lifecycle_state, lifecycle_details, time_connection_status_last_updated, 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



335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 335

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



329
330
331
 
# File 'lib/oci/database_management/models/external_db_system_connector.rb', line 329

def to_s
  to_hash.to_s
end