Class: OCI::GoldenGate::Models::ConnectionAssignment

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/golden_gate/models/connection_assignment.rb

Overview

Represents the metadata description of a connection assignment. Before you can use a connection as a GoldenGate source or target, you must assign it to a deployment.

Constant Summary collapse

CONNECTION_TYPE_ENUM =
[
  CONNECTION_TYPE_GOLDENGATE = 'GOLDENGATE'.freeze,
  CONNECTION_TYPE_KAFKA = 'KAFKA'.freeze,
  CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'.freeze,
  CONNECTION_TYPE_MYSQL = 'MYSQL'.freeze,
  CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'.freeze,
  CONNECTION_TYPE_MICROSOFT_SQLSERVER = 'MICROSOFT_SQLSERVER'.freeze,
  CONNECTION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'.freeze,
  CONNECTION_TYPE_ORACLE = 'ORACLE'.freeze,
  CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'.freeze,
  CONNECTION_TYPE_POSTGRESQL = 'POSTGRESQL'.freeze,
  CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS = 'AZURE_SYNAPSE_ANALYTICS'.freeze,
  CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'.freeze,
  CONNECTION_TYPE_AMAZON_S3 = 'AMAZON_S3'.freeze,
  CONNECTION_TYPE_HDFS = 'HDFS'.freeze,
  CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM = 'ORACLE_AI_DATA_PLATFORM'.freeze,
  CONNECTION_TYPE_ORACLE_NOSQL = 'ORACLE_NOSQL'.freeze,
  CONNECTION_TYPE_MONGODB = 'MONGODB'.freeze,
  CONNECTION_TYPE_AMAZON_KINESIS = 'AMAZON_KINESIS'.freeze,
  CONNECTION_TYPE_AMAZON_REDSHIFT = 'AMAZON_REDSHIFT'.freeze,
  CONNECTION_TYPE_DB2 = 'DB2'.freeze,
  CONNECTION_TYPE_REDIS = 'REDIS'.freeze,
  CONNECTION_TYPE_ELASTICSEARCH = 'ELASTICSEARCH'.freeze,
  CONNECTION_TYPE_GENERIC = 'GENERIC'.freeze,
  CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'.freeze,
  CONNECTION_TYPE_GOOGLE_BIGQUERY = 'GOOGLE_BIGQUERY'.freeze,
  CONNECTION_TYPE_DATABRICKS = 'DATABRICKS'.freeze,
  CONNECTION_TYPE_GOOGLE_PUBSUB = 'GOOGLE_PUBSUB'.freeze,
  CONNECTION_TYPE_MICROSOFT_FABRIC = 'MICROSOFT_FABRIC'.freeze,
  CONNECTION_TYPE_ICEBERG = 'ICEBERG'.freeze,
  CONNECTION_TYPE_AI_MODEL = 'AI_MODEL'.freeze,
  CONNECTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.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 = {}) ⇒ ConnectionAssignment

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 property

  • :connection_id (String)

    The value to assign to the #connection_id property

  • :connection_type (String)

    The value to assign to the #connection_type property

  • :deployment_id (String)

    The value to assign to the #deployment_id property

  • :alias_name (String)

    The value to assign to the #alias_name property

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :time_updated (DateTime)

    The value to assign to the #time_updated property



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

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

  self.connection_id = attributes[:'connectionId'] if attributes[:'connectionId']

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

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

  self.connection_type = attributes[:'connectionType'] if attributes[:'connectionType']

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

  self.connection_type = attributes[:'connection_type'] if attributes[:'connection_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.alias_name = attributes[:'aliasName'] if attributes[:'aliasName']

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

  self.alias_name = attributes[:'alias_name'] if attributes[:'alias_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.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.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

#alias_nameString

Credential store alias.

Returns:

  • (String)


82
83
84
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 82

def alias_name
  @alias_name
end

#compartment_idString

[Required] The OCID of the compartment being referenced.

Returns:

  • (String)


87
88
89
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 87

def compartment_id
  @compartment_id
end

#connection_idString

[Required] The OCID of the connection being referenced.

Returns:

  • (String)


67
68
69
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 67

def connection_id
  @connection_id
end

#connection_typeString

[Required] The connection type.

Returns:

  • (String)


72
73
74
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 72

def connection_type
  @connection_type
end

#deployment_idString

[Required] The OCID of the deployment being referenced.

Returns:

  • (String)


77
78
79
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 77

def deployment_id
  @deployment_id
end

#idString

[Required] The OCID of the connection assignment being referenced.

Returns:

  • (String)


61
62
63
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 61

def id
  @id
end

#lifecycle_stateString

[Required] Possible lifecycle states for connection assignments.

Returns:

  • (String)


91
92
93
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 91

def lifecycle_state
  @lifecycle_state
end

#time_createdDateTime

[Required] The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime)


97
98
99
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 97

def time_created
  @time_created
end

#time_updatedDateTime

[Required] The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime)


103
104
105
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 103

def time_updated
  @time_updated
end

Class Method Details

.attribute_mapObject

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 106

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'connection_id': :'connectionId',
    'connection_type': :'connectionType',
    'deployment_id': :'deploymentId',
    'alias_name': :'aliasName',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 123

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'connection_id': :'String',
    'connection_type': :'String',
    'deployment_id': :'String',
    'alias_name': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    '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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 244

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

  self.class == other.class &&
    id == other.id &&
    connection_id == other.connection_id &&
    connection_type == other.connection_type &&
    deployment_id == other.deployment_id &&
    alias_name == other.alias_name &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 282

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


262
263
264
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 262

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



271
272
273
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 271

def hash
  [id, connection_id, connection_type, deployment_id, alias_name, compartment_id, lifecycle_state, time_created, time_updated].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



315
316
317
318
319
320
321
322
323
324
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 315

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



309
310
311
# File 'lib/oci/golden_gate/models/connection_assignment.rb', line 309

def to_s
  to_hash.to_s
end