Class: OCI::DataIntegration::Models::DataAsset

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

Overview

Represents a data source in the Data Integration service. 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_DATA_ASSET = 'ORACLE_DATA_ASSET'.freeze,
  MODEL_TYPE_ORACLE_OBJECT_STORAGE_DATA_ASSET = 'ORACLE_OBJECT_STORAGE_DATA_ASSET'.freeze,
  MODEL_TYPE_ORACLE_ATP_DATA_ASSET = 'ORACLE_ATP_DATA_ASSET'.freeze,
  MODEL_TYPE_ORACLE_ADWC_DATA_ASSET = 'ORACLE_ADWC_DATA_ASSET'.freeze,
  MODEL_TYPE_MYSQL_DATA_ASSET = 'MYSQL_DATA_ASSET'.freeze,
  MODEL_TYPE_GENERIC_JDBC_DATA_ASSET = 'GENERIC_JDBC_DATA_ASSET'.freeze,
  MODEL_TYPE_FUSION_APP_DATA_ASSET = 'FUSION_APP_DATA_ASSET'.freeze,
  MODEL_TYPE_AMAZON_S3_DATA_ASSET = 'AMAZON_S3_DATA_ASSET'.freeze,
  MODEL_TYPE_LAKE_DATA_ASSET = 'LAKE_DATA_ASSET'.freeze,
  MODEL_TYPE_ORACLE_PEOPLESOFT_DATA_ASSET = 'ORACLE_PEOPLESOFT_DATA_ASSET'.freeze,
  MODEL_TYPE_ORACLE_SIEBEL_DATA_ASSET = 'ORACLE_SIEBEL_DATA_ASSET'.freeze,
  MODEL_TYPE_ORACLE_EBS_DATA_ASSET = 'ORACLE_EBS_DATA_ASSET'.freeze,
  MODEL_TYPE_HDFS_DATA_ASSET = 'HDFS_DATA_ASSET'.freeze,
  MODEL_TYPE_MYSQL_HEATWAVE_DATA_ASSET = 'MYSQL_HEATWAVE_DATA_ASSET'.freeze,
  MODEL_TYPE_REST_DATA_ASSET = 'REST_DATA_ASSET'.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 = {}) ⇒ DataAsset

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

  self.asset_properties = attributes[:'assetProperties'] if attributes[:'assetProperties']

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

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

  self.native_type_system = attributes[:'nativeTypeSystem'] if attributes[:'nativeTypeSystem']

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

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

  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.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.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

#asset_properties ⇒ Hash<String, String>

Additional properties for the data asset.

Returns:

  • (Hash<String, String>) 


66
67
68
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 66

def asset_properties
  @asset_properties
end

#description ⇒ String

User-defined description of the data asset.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 50

def description
  @description
end

#external_key ⇒ String

The external key for the object.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 62

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


58
59
60
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 58

def identifier
  @identifier
end

#key ⇒ String

Generated key that can be used in API calls to identify data asset.

Returns:

  • (String) 


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

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


83
84
85
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 83

def key_map
  @key_map
end

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

Returns:



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

def metadata
  @metadata
end

#model_type ⇒ String

The type of the data asset.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/data_integration/models/data_asset.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/data_asset.rb', line 42

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) 


46
47
48
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 46

def name
  @name
end

#native_type_system ⇒ OCI::DataIntegration::Models::TypeSystem

Returns:



69
70
71
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 69

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


54
55
56
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 54

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) 


73
74
75
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 73

def object_version
  @object_version
end

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

Returns:



76
77
78
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 76

def parent_ref
  @parent_ref
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'key': :'key',
    'model_version': :'modelVersion',
    'name': :'name',
    'description': :'description',
    'object_status': :'objectStatus',
    'identifier': :'identifier',
    'external_key': :'externalKey',
    'asset_properties': :'assetProperties',
    'native_type_system': :'nativeTypeSystem',
    'object_version': :'objectVersion',
    'parent_ref': :'parentRef',
    '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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 134

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

  return 'OCI::DataIntegration::Models::DataAssetFromJdbc' if type == 'GENERIC_JDBC_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromOracleDetails' if type == 'ORACLE_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromAmazonS3' if type == 'AMAZON_S3_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromMySqlHeatWave' if type == 'MYSQL_HEATWAVE_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromMySQL' if type == 'MYSQL_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromOraclePeopleSoftDetails' if type == 'ORACLE_PEOPLESOFT_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromOracleEbsDetails' if type == 'ORACLE_EBS_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromRestDetails' if type == 'REST_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromAdwcDetails' if type == 'ORACLE_ADWC_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromHdfsDetails' if type == 'HDFS_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromOracleSiebelDetails' if type == 'ORACLE_SIEBEL_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromObjectStorageDetails' if type == 'ORACLE_OBJECT_STORAGE_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromFusionApp' if type == 'FUSION_APP_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromLakeDetails' if type == 'LAKE_DATA_ASSET'
  return 'OCI::DataIntegration::Models::DataAssetFromAtpDetails' if type == 'ORACLE_ATP_DATA_ASSET'

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

.swagger_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 108

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'key': :'String',
    'model_version': :'String',
    'name': :'String',
    'description': :'String',
    'object_status': :'Integer',
    'identifier': :'String',
    'external_key': :'String',
    'asset_properties': :'Hash<String, String>',
    'native_type_system': :'OCI::DataIntegration::Models::TypeSystem',
    'object_version': :'Integer',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    '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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 269

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

  self.class == other.class &&
    model_type == other.model_type &&
    key == other.key &&
    model_version == other.model_version &&
    name == other.name &&
    description == other.description &&
    object_status == other.object_status &&
    identifier == other.identifier &&
    external_key == other.external_key &&
    asset_properties == other.asset_properties &&
    native_type_system == other.native_type_system &&
    object_version == other.object_version &&
    parent_ref == other.parent_ref &&
    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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 312

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


292
293
294
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 292

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



301
302
303
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 301

def hash
  [model_type, key, model_version, name, description, object_status, identifier, external_key, asset_properties, native_type_system, object_version, parent_ref, 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



345
346
347
348
349
350
351
352
353
354
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 345

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



339
340
341
 
# File 'lib/oci/data_integration/models/data_asset.rb', line 339

def to_s
  to_hash.to_s
end