Class: OCI::DataIntegration::Models::CreateConnectionDetails

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

Overview

Properties used in connection create operations. 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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateConnectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



153
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
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 153

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

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

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

Instance Attribute Details

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

The properties for the connection.

Returns:



65
66
67
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 65

def connection_properties
  @connection_properties
end

#description ⇒ String

User-defined description for the connection.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 53

def description
  @description
end

#identifier ⇒ String

[Required] 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) 


61
62
63
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 61

def identifier
  @identifier
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) 


38
39
40
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 38

def key
  @key
end

#model_type ⇒ String

The type of the connection.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 34

def model_type
  @model_type
end

#model_version ⇒ String

The model version of an object.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 42

def model_version
  @model_version
end

#name ⇒ String

[Required] 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) 


49
50
51
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 49

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) 


57
58
59
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 57

def object_status
  @object_status
end

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

Returns:



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

def parent_ref
  @parent_ref
end

#registry_metadata ⇒ OCI::DataIntegration::Models::RegistryMetadata

Returns:



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

def registry_metadata
  @registry_metadata
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'key': :'key',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'name': :'name',
    'description': :'description',
    'object_status': :'objectStatus',
    'identifier': :'identifier',
    'connection_properties': :'connectionProperties',
    'registry_metadata': :'registryMetadata'
    # 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.



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

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

  return 'OCI::DataIntegration::Models::CreateConnectionFromOracleSiebel' if type == 'ORACLE_SIEBEL_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromAmazonS3' if type == 'AMAZON_S3_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromBICC' if type == 'BICC_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromAtp' if type == 'ORACLE_ATP_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromHdfs' if type == 'HDFS_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromMySqlHeatWave' if type == 'MYSQL_HEATWAVE_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromRestBasicAuth' if type == 'REST_BASIC_AUTH_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromOracle' if type == 'ORACLEDB_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromOraclePeopleSoft' if type == 'ORACLE_PEOPLESOFT_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromOracleEbs' if type == 'ORACLE_EBS_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromMySQL' if type == 'MYSQL_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromJdbc' if type == 'GENERIC_JDBC_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromBIP' if type == 'BIP_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromAdwc' if type == 'ORACLE_ADWC_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromRestNoAuth' if type == 'REST_NO_AUTH_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromObjectStorage' if type == 'ORACLE_OBJECT_STORAGE_CONNECTION'
  return 'OCI::DataIntegration::Models::CreateConnectionFromLake' if type == 'LAKE_CONNECTION'

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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_status': :'Integer',
    'identifier': :'String',
    'connection_properties': :'Array<OCI::DataIntegration::Models::ConnectionProperty>',
    'registry_metadata': :'OCI::DataIntegration::Models::RegistryMetadata'
    # 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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 219

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_status == other.object_status &&
    identifier == other.identifier &&
    connection_properties == other.connection_properties &&
    registry_metadata == other.registry_metadata
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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 258

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


238
239
240
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 238

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



247
248
249
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 247

def hash
  [model_type, key, model_version, parent_ref, name, description, object_status, identifier, connection_properties, registry_metadata].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



291
292
293
294
295
296
297
298
299
300
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 291

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



285
286
287
 
# File 'lib/oci/data_integration/models/create_connection_details.rb', line 285

def to_s
  to_hash.to_s
end