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):



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

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']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#agent_id ⇒ String

[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_info ⇒ OCI::DatabaseManagement::Models::ExternalDbSystemConnectionInfo

Returns:



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

def connection_info
  @connection_info
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


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

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


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

def system_tags
  @system_tags
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
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_management/models/external_db_system_macs_connector.rb', line 48

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',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 73

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',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 167

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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 213

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


193
194
195
 
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 193

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



202
203
204
 
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 202

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, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 246

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



240
241
242
 
# File 'lib/oci/database_management/models/external_db_system_macs_connector.rb', line 240

def to_s
  to_hash.to_s
end