Class: OCI::Database::Models::ExternalMacsConnector

Inherits:
ExternalDatabaseConnector show all
Defined in:
lib/oci/database/models/external_macs_connector.rb

Overview

An Oracle Cloud Infrastructure resource that uses the [Management Agent cloud service (MACS)](docs.cloud.oracle.com/iaas/management-agents/index.html) to connect to an external Oracle Database.

Constant Summary

Constants inherited from ExternalDatabaseConnector

OCI::Database::Models::ExternalDatabaseConnector::CONNECTOR_TYPE_ENUM, OCI::Database::Models::ExternalDatabaseConnector::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ExternalDatabaseConnector

#compartment_id, #connection_status, #connector_type, #defined_tags, #display_name, #external_database_id, #freeform_tags, #id, #lifecycle_details, #lifecycle_state, #time_connection_status_last_updated, #time_created

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ExternalDatabaseConnector

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ExternalMacsConnector

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/database/models/external_macs_connector.rb', line 92

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

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

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

  self.connection_credentials = attributes[:'connectionCredentials'] if attributes[:'connectionCredentials']

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

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

  self.connector_agent_id = attributes[:'connectorAgentId'] if attributes[:'connectorAgentId']

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

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

Instance Attribute Details

#connection_credentials ⇒ OCI::Database::Models::DatabaseConnectionCredentials

This attribute is required.

Returns:



18
19
20
 
# File 'lib/oci/database/models/external_macs_connector.rb', line 18

def connection_credentials
  @connection_credentials
end

#connection_string ⇒ OCI::Database::Models::DatabaseConnectionString

This attribute is required.

Returns:



14
15
16
 
# File 'lib/oci/database/models/external_macs_connector.rb', line 14

def connection_string
  @connection_string
end

#connector_agent_id ⇒ String

[Required] The ID of the agent used for the create_external_database_connector_details.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/database/models/external_macs_connector.rb', line 24

def connector_agent_id
  @connector_agent_id
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/database/models/external_macs_connector.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'connector_type': :'connectorType',
    'external_database_id': :'externalDatabaseId',
    'connection_status': :'connectionStatus',
    'time_connection_status_last_updated': :'timeConnectionStatusLastUpdated',
    'connection_string': :'connectionString',
    'connection_credentials': :'connectionCredentials',
    'connector_agent_id': :'connectorAgentId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/database/models/external_macs_connector.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'connector_type': :'String',
    'external_database_id': :'String',
    'connection_status': :'String',
    'time_connection_status_last_updated': :'DateTime',
    'connection_string': :'OCI::Database::Models::DatabaseConnectionString',
    'connection_credentials': :'OCI::Database::Models::DatabaseConnectionCredentials',
    'connector_agent_id': :'String'
    # 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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/database/models/external_macs_connector.rb', line 128

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    connector_type == other.connector_type &&
    external_database_id == other.external_database_id &&
    connection_status == other.connection_status &&
    time_connection_status_last_updated == other.time_connection_status_last_updated &&
    connection_string == other.connection_string &&
    connection_credentials == other.connection_credentials &&
    connector_agent_id == other.connector_agent_id
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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/database/models/external_macs_connector.rb', line 172

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


152
153
154
 
# File 'lib/oci/database/models/external_macs_connector.rb', line 152

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



161
162
163
 
# File 'lib/oci/database/models/external_macs_connector.rb', line 161

def hash
  [compartment_id, freeform_tags, defined_tags, display_name, id, lifecycle_state, lifecycle_details, time_created, connector_type, external_database_id, connection_status, time_connection_status_last_updated, connection_string, connection_credentials, connector_agent_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/database/models/external_macs_connector.rb', line 205

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



199
200
201
 
# File 'lib/oci/database/models/external_macs_connector.rb', line 199

def to_s
  to_hash.to_s
end