Class: OCI::DatabaseManagement::Models::ExternalDbSystemMacsConnector

Inherits:
ExternalDbSystemConnector show all
Defined in:
lib/oci/database_management/models/external_db_system_macs_connector.rb

Overview

The details of an external DB system connector that uses the Management Agent Cloud Service (MACS) to connect to an external DB system component.

Constant Summary

Constants inherited from ExternalDbSystemConnector

OCI::DatabaseManagement::Models::ExternalDbSystemConnector::CONNECTOR_TYPE_ENUM, OCI::DatabaseManagement::Models::ExternalDbSystemConnector::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ExternalDbSystemConnector

#compartment_id, #connection_failure_message, #connection_status, #connector_type, #display_name, #external_db_system_id, #id, #lifecycle_details, #lifecycle_state, #time_connection_status_last_updated, #time_created, #time_updated

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ExternalDbSystemConnector

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ExternalDbSystemMacsConnector

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 87

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

  attributes['connectorType'] = 'MACS'

  super(attributes)

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

  self.agent_id = attributes[:'agentId'] if attributes[:'agentId']

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

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

  self.connection_info = attributes[:'connectionInfo'] if attributes[:'connectionInfo']

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

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

Instance Attribute Details

#agent_idString

[Required] The OCID of the management agent used for the external DB system connector.

Returns:

  • (String)


19
20
21
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 19

def agent_id
  @agent_id
end

#connection_infoOCI::DatabaseManagement::Models::ExternalDbSystemConnectionInfo



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

def connection_info
  @connection_info
end

Class Method Details

.attribute_mapObject

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



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 25

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',
    'agent_id': :'agentId',
    'connection_info': :'connectionInfo'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 47

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',
    'agent_id': :'String',
    'connection_info': :'OCI::DatabaseManagement::Models::ExternalDbSystemConnectionInfo'
    # 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



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

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 &&
    agent_id == other.agent_id &&
    connection_info == other.connection_info
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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 160

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


140
141
142
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 140

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



149
150
151
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 149

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



193
194
195
196
197
198
199
200
201
202
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 193

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



187
188
189
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 187

def to_s
  to_hash.to_s
end