Class: OCI::DataIntegration::Models::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_integration/models/connection.rb

Overview

The connection for a data asset. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

MODEL_TYPE_ENUM = 
[
  MODEL_TYPE_ORACLE_ADWC_CONNECTION = 'ORACLE_ADWC_CONNECTION'.freeze,
  MODEL_TYPE_ORACLE_ATP_CONNECTION = 'ORACLE_ATP_CONNECTION'.freeze,
  MODEL_TYPE_ORACLE_OBJECT_STORAGE_CONNECTION = 'ORACLE_OBJECT_STORAGE_CONNECTION'.freeze,
  MODEL_TYPE_ORACLEDB_CONNECTION = 'ORACLEDB_CONNECTION'.freeze,
  MODEL_TYPE_MYSQL_CONNECTION = 'MYSQL_CONNECTION'.freeze,
  MODEL_TYPE_GENERIC_JDBC_CONNECTION = 'GENERIC_JDBC_CONNECTION'.freeze,
  MODEL_TYPE_BICC_CONNECTION = 'BICC_CONNECTION'.freeze,
  MODEL_TYPE_AMAZON_S3_CONNECTION = 'AMAZON_S3_CONNECTION'.freeze,
  MODEL_TYPE_BIP_CONNECTION = 'BIP_CONNECTION'.freeze,
  MODEL_TYPE_LAKE_CONNECTION = 'LAKE_CONNECTION'.freeze,
  MODEL_TYPE_ORACLE_PEOPLESOFT_CONNECTION = 'ORACLE_PEOPLESOFT_CONNECTION'.freeze,
  MODEL_TYPE_ORACLE_EBS_CONNECTION = 'ORACLE_EBS_CONNECTION'.freeze,
  MODEL_TYPE_ORACLE_SIEBEL_CONNECTION = 'ORACLE_SIEBEL_CONNECTION'.freeze,
  MODEL_TYPE_HDFS_CONNECTION = 'HDFS_CONNECTION'.freeze,
  MODEL_TYPE_MYSQL_HEATWAVE_CONNECTION = 'MYSQL_HEATWAVE_CONNECTION'.freeze,
  MODEL_TYPE_REST_NO_AUTH_CONNECTION = 'REST_NO_AUTH_CONNECTION'.freeze,
  MODEL_TYPE_REST_BASIC_AUTH_CONNECTION = 'REST_BASIC_AUTH_CONNECTION'.freeze,
  MODEL_TYPE_OAUTH2_CONNECTION = 'OAUTH2_CONNECTION'.freeze,
  MODEL_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Connection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/data_integration/models/connection.rb', line 184

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

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

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

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

  self.model_version = attributes[:'modelVersion'] if attributes[:'modelVersion']

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

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

  self.parent_ref = attributes[:'parentRef'] if attributes[:'parentRef']

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

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

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

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

  self.object_version = attributes[:'objectVersion'] if attributes[:'objectVersion']

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

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

  self.object_status = attributes[:'objectStatus'] if attributes[:'objectStatus']

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

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

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

  self.primary_schema = attributes[:'primarySchema'] if attributes[:'primarySchema']

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

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

  self.connection_properties = attributes[:'connectionProperties'] if attributes[:'connectionProperties']

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

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

  self.is_default = attributes[:'isDefault'] unless attributes[:'isDefault'].nil?
  self.is_default = false if is_default.nil? && !attributes.key?(:'isDefault') # rubocop:disable Style/StringLiterals

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

  self.is_default = attributes[:'is_default'] unless attributes[:'is_default'].nil?
  self.is_default = false if is_default.nil? && !attributes.key?(:'isDefault') && !attributes.key?(:'is_default') # rubocop:disable Style/StringLiterals

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

  self.key_map = attributes[:'keyMap'] if attributes[:'keyMap']

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

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

Instance Attribute Details

#connection_properties ⇒ Array<OCI::DataIntegration::Models::ConnectionProperty>

The properties for the connection.

Returns:



75
76
77
 
# File 'lib/oci/data_integration/models/connection.rb', line 75

def connection_properties
  @connection_properties
end

#description ⇒ String

User-defined description for the connection.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/data_integration/models/connection.rb', line 56

def description
  @description
end

#identifier ⇒ String

Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/data_integration/models/connection.rb', line 68

def identifier
  @identifier
end

#is_default ⇒ BOOLEAN

The default property for the connection.

Returns:

  • (BOOLEAN) 


79
80
81
 
# File 'lib/oci/data_integration/models/connection.rb', line 79

def is_default
  @is_default
end

#key ⇒ String

Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/data_integration/models/connection.rb', line 41

def key
  @key
end

#key_map ⇒ Hash<String, String>

A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.

Returns:

  • (Hash<String, String>) 


86
87
88
 
# File 'lib/oci/data_integration/models/connection.rb', line 86

def key_map
  @key_map
end

#metadata ⇒ OCI::DataIntegration::Models::ObjectMetadata

Returns:



82
83
84
 
# File 'lib/oci/data_integration/models/connection.rb', line 82

def metadata
  @metadata
end

#model_type ⇒ String

[Required] The type of the connection.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/data_integration/models/connection.rb', line 37

def model_type
  @model_type
end

#model_version ⇒ String

The model version of an object.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/data_integration/models/connection.rb', line 45

def model_version
  @model_version
end

#name ⇒ String

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/data_integration/models/connection.rb', line 52

def name
  @name
end

#object_status ⇒ Integer

The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/oci/data_integration/models/connection.rb', line 64

def object_status
  @object_status
end

#object_version ⇒ Integer

The version of the object that is used to track changes in the object instance.

Returns:

  • (Integer) 


60
61
62
 
# File 'lib/oci/data_integration/models/connection.rb', line 60

def object_version
  @object_version
end

#parent_ref ⇒ OCI::DataIntegration::Models::ParentReference

Returns:



48
49
50
 
# File 'lib/oci/data_integration/models/connection.rb', line 48

def parent_ref
  @parent_ref
end

#primary_schema ⇒ OCI::DataIntegration::Models::Schema

Returns:



71
72
73
 
# File 'lib/oci/data_integration/models/connection.rb', line 71

def primary_schema
  @primary_schema
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'key': :'key',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'name': :'name',
    'description': :'description',
    'object_version': :'objectVersion',
    'object_status': :'objectStatus',
    'identifier': :'identifier',
    'primary_schema': :'primarySchema',
    'connection_properties': :'connectionProperties',
    'is_default': :'isDefault',
    'metadata': :'metadata',
    'key_map': :'keyMap'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/data_integration/models/connection.rb', line 137

def self.get_subtype(object_hash)
  type = object_hash[:'modelType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DataIntegration::Models::ConnectionFromAmazonS3' if type == 'AMAZON_S3_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromBIP' if type == 'BIP_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromMySQL' if type == 'MYSQL_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromOAuth2' if type == 'OAUTH2_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromJdbc' if type == 'GENERIC_JDBC_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromBICC' if type == 'BICC_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromMySqlHeatWave' if type == 'MYSQL_HEATWAVE_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromRestBasicAuth' if type == 'REST_BASIC_AUTH_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromObjectStorage' if type == 'ORACLE_OBJECT_STORAGE_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromAdwc' if type == 'ORACLE_ADWC_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromAtp' if type == 'ORACLE_ATP_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromOracle' if type == 'ORACLEDB_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromOraclePeopleSoft' if type == 'ORACLE_PEOPLESOFT_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromHdfs' if type == 'HDFS_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromOracleEbs' if type == 'ORACLE_EBS_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromOracleSiebel' if type == 'ORACLE_SIEBEL_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromRestNoAuth' if type == 'REST_NO_AUTH_CONNECTION'
  return 'OCI::DataIntegration::Models::ConnectionFromLake' if type == 'LAKE_CONNECTION'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DataIntegration::Models::Connection'
end

.swagger_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/data_integration/models/connection.rb', line 111

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'key': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'name': :'String',
    'description': :'String',
    'object_version': :'Integer',
    'object_status': :'Integer',
    'identifier': :'String',
    'primary_schema': :'OCI::DataIntegration::Models::Schema',
    'connection_properties': :'Array<OCI::DataIntegration::Models::ConnectionProperty>',
    'is_default': :'BOOLEAN',
    'metadata': :'OCI::DataIntegration::Models::ObjectMetadata',
    'key_map': :'Hash<String, 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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/oci/data_integration/models/connection.rb', line 277

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

  self.class == other.class &&
    model_type == other.model_type &&
    key == other.key &&
    model_version == other.model_version &&
    parent_ref == other.parent_ref &&
    name == other.name &&
    description == other.description &&
    object_version == other.object_version &&
    object_status == other.object_status &&
    identifier == other.identifier &&
    primary_schema == other.primary_schema &&
    connection_properties == other.connection_properties &&
    is_default == other.is_default &&
    metadata == other.metadata &&
    key_map == other.key_map
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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/oci/data_integration/models/connection.rb', line 320

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


300
301
302
 
# File 'lib/oci/data_integration/models/connection.rb', line 300

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



309
310
311
 
# File 'lib/oci/data_integration/models/connection.rb', line 309

def hash
  [model_type, key, model_version, parent_ref, name, description, object_version, object_status, identifier, primary_schema, connection_properties, is_default, metadata, key_map].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



353
354
355
356
357
358
359
360
361
362
 
# File 'lib/oci/data_integration/models/connection.rb', line 353

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



347
348
349
 
# File 'lib/oci/data_integration/models/connection.rb', line 347

def to_s
  to_hash.to_s
end