Class: OCI::GoldenGate::Models::GoldenGateConnectionSummary

Inherits:
ConnectionSummary show all
Defined in:
lib/oci/golden_gate/models/golden_gate_connection_summary.rb

Overview

Summary of the GoldenGate Connection.

Constant Summary

Constants inherited from ConnectionSummary

ConnectionSummary::CONNECTION_TYPE_ENUM, ConnectionSummary::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from ConnectionSummary

#compartment_id, #connection_type, #defined_tags, #description, #display_name, #does_use_secret_ids, #freeform_tags, #id, #ingress_ips, #key_id, #lifecycle_details, #lifecycle_state, #locks, #nsg_ids, #routing_method, #subnet_id, #system_tags, #time_created, #time_updated, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ConnectionSummary

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ GoldenGateConnectionSummary

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 proprety

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :compartment_id (String) —

    The value to assign to the #compartment_id proprety

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags proprety

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

    The value to assign to the #time_updated proprety

  • :vault_id (String) —

    The value to assign to the #vault_id proprety

  • :key_id (String) —

    The value to assign to the #key_id proprety

  • :ingress_ips (Array<OCI::GoldenGate::Models::IngressIpDetails>) —

    The value to assign to the #ingress_ips proprety

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids proprety

  • :subnet_id (String) —

    The value to assign to the #subnet_id proprety

  • :routing_method (String) —

    The value to assign to the #routing_method proprety

  • :locks (Array<OCI::GoldenGate::Models::ResourceLock>) —

    The value to assign to the #locks proprety

  • :does_use_secret_ids (BOOLEAN) —

    The value to assign to the #does_use_secret_ids proprety

  • :technology_type (String) —

    The value to assign to the #technology_type property

  • :deployment_id (String) —

    The value to assign to the #deployment_id property

  • :host (String) —

    The value to assign to the #host property

  • :port (Integer) —

    The value to assign to the #port property

  • :username (String) —

    The value to assign to the #username property

  • :private_ip (String) —

    The value to assign to the #private_ip property

  • :password_secret_id (String) —

    The value to assign to the #password_secret_id property



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
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 158

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

  attributes['connectionType'] = 'GOLDENGATE'

  super(attributes)

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

  self.technology_type = attributes[:'technologyType'] if attributes[:'technologyType']

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

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

  self.deployment_id = attributes[:'deploymentId'] if attributes[:'deploymentId']

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

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

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

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

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

  self.private_ip = attributes[:'privateIp'] if attributes[:'privateIp']

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

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

  self.password_secret_id = attributes[:'passwordSecretId'] if attributes[:'passwordSecretId']

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

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

Instance Attribute Details

#deployment_id ⇒ String

The OCID of the deployment being referenced.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 20

def deployment_id
  @deployment_id
end

#host ⇒ String

The name or address of a host.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 25

def host
  @host
end

#password_secret_id ⇒ String

The OCID of the Secret where the password is stored, which is used to connect to the Oracle GoldenGate accessed trough this connection. Note: When provided, 'password' field must not be provided.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 54

def password_secret_id
  @password_secret_id
end

#port ⇒ Integer

The port of an endpoint usually specified for a connection.

Returns:

  • (Integer) 


30
31
32
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 30

def port
  @port
end

#private_ip ⇒ String

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.

The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 47

def private_ip
  @private_ip
end

#technology_type ⇒ String

[Required] The GoldenGate technology type.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 15

def technology_type
  @technology_type
end

#username ⇒ String

The username credential existing in the Oracle GoldenGate used to be connected to.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 35

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 57

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'ingress_ips': :'ingressIps',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'locks': :'locks',
    'does_use_secret_ids': :'doesUseSecretIds',
    'technology_type': :'technologyType',
    'deployment_id': :'deploymentId',
    'host': :'host',
    'port': :'port',
    'username': :'username',
    'private_ip': :'privateIp',
    'password_secret_id': :'passwordSecretId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
120
121
122
123
124
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 92

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'vault_id': :'String',
    'key_id': :'String',
    'ingress_ips': :'Array<OCI::GoldenGate::Models::IngressIpDetails>',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'locks': :'Array<OCI::GoldenGate::Models::ResourceLock>',
    'does_use_secret_ids': :'BOOLEAN',
    'technology_type': :'String',
    'deployment_id': :'String',
    'host': :'String',
    'port': :'Integer',
    'username': :'String',
    'private_ip': :'String',
    'password_secret_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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 206

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    ingress_ips == other.ingress_ips &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    locks == other.locks &&
    does_use_secret_ids == other.does_use_secret_ids &&
    technology_type == other.technology_type &&
    deployment_id == other.deployment_id &&
    host == other.host &&
    port == other.port &&
    username == other.username &&
    private_ip == other.private_ip &&
    password_secret_id == other.password_secret_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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 262

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


242
243
244
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 242

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



251
252
253
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 251

def hash
  [connection_type, id, display_name, description, compartment_id, freeform_tags, defined_tags, system_tags, lifecycle_state, lifecycle_details, time_created, time_updated, vault_id, key_id, ingress_ips, nsg_ids, subnet_id, routing_method, locks, does_use_secret_ids, technology_type, deployment_id, host, port, username, private_ip, password_secret_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



295
296
297
298
299
300
301
302
303
304
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 295

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



289
290
291
 
# File 'lib/oci/golden_gate/models/golden_gate_connection_summary.rb', line 289

def to_s
  to_hash.to_s
end