Class: OCI::DataConnectivity::Models::DataAsset

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

Overview

Represents a data source in the Data Integration service.

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



148
149
150
151
152
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
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
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 148

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

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

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

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

  self.default_connection = attributes[:'defaultConnection'] if attributes[:'defaultConnection']

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

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

  self.end_points = attributes[:'endPoints'] if attributes[:'endPoints']

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

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

Instance Attribute Details

#asset_properties ⇒ Hash<String, String>

Additional properties for the data asset.

Returns:

  • (Hash<String, String>) 


49
50
51
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 49

def asset_properties
  @asset_properties
end

#default_connection ⇒ OCI::DataConnectivity::Models::Connection

Returns:



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

def default_connection
  @default_connection
end

#description ⇒ String

User-defined description of the data asset.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 29

def description
  @description
end

#end_points ⇒ Array<OCI::DataConnectivity::Models::DpEndpoint>

The list of endpoints with which this data asset is associated.

Returns:



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

def end_points
  @end_points
end

#external_key ⇒ String

The external key for the object.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 45

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


41
42
43
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 41

def identifier
  @identifier
end

#key ⇒ String

**[Required]** Currently not used on data asset creation. Reserved for future.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 13

def key
  @key
end

#metadata ⇒ OCI::DataConnectivity::Models::ObjectMetadata

Returns:



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

def metadata
  @metadata
end

#model_type ⇒ String

The type of the object.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 21

def model_type
  @model_type
end

#model_version ⇒ String

The model version of an object.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 17

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) 


25
26
27
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 25

def name
  @name
end

#native_type_system ⇒ OCI::DataConnectivity::Models::TypeSystem

Returns:



60
61
62
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 60

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) 


33
34
35
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 33

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) 


37
38
39
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 37

def object_version
  @object_version
end

#properties ⇒ Hash<String, Object>

All the properties for the data asset in a key-value map format.

Returns:

  • (Hash<String, Object>) 


53
54
55
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 53

def properties
  @properties
end

#registry_metadata ⇒ OCI::DataConnectivity::Models::RegistryMetadata

Returns:



63
64
65
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 63

def registry_metadata
  @registry_metadata
end

#type ⇒ String

Specific DataAsset Type

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 57

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 76

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'model_version': :'modelVersion',
    'model_type': :'modelType',
    'name': :'name',
    'description': :'description',
    'object_status': :'objectStatus',
    'object_version': :'objectVersion',
    'identifier': :'identifier',
    'external_key': :'externalKey',
    'asset_properties': :'assetProperties',
    'properties': :'properties',
    'type': :'type',
    'native_type_system': :'nativeTypeSystem',
    'registry_metadata': :'registryMetadata',
    'metadata': :'metadata',
    'default_connection': :'defaultConnection',
    'end_points': :'endPoints'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 101

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'model_version': :'String',
    'model_type': :'String',
    'name': :'String',
    'description': :'String',
    'object_status': :'Integer',
    'object_version': :'Integer',
    'identifier': :'String',
    'external_key': :'String',
    'asset_properties': :'Hash<String, String>',
    'properties': :'Hash<String, Object>',
    'type': :'String',
    'native_type_system': :'OCI::DataConnectivity::Models::TypeSystem',
    'registry_metadata': :'OCI::DataConnectivity::Models::RegistryMetadata',
    'metadata': :'OCI::DataConnectivity::Models::ObjectMetadata',
    'default_connection': :'OCI::DataConnectivity::Models::Connection',
    'end_points': :'Array<OCI::DataConnectivity::Models::DpEndpoint>'
    # 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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 236

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

  self.class == other.class &&
    key == other.key &&
    model_version == other.model_version &&
    model_type == other.model_type &&
    name == other.name &&
    description == other.description &&
    object_status == other.object_status &&
    object_version == other.object_version &&
    identifier == other.identifier &&
    external_key == other.external_key &&
    asset_properties == other.asset_properties &&
    properties == other.properties &&
    type == other.type &&
    native_type_system == other.native_type_system &&
    registry_metadata == other.registry_metadata &&
    metadata == other.metadata &&
    default_connection == other.default_connection &&
    end_points == other.end_points
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/data_connectivity/models/data_asset.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/data_connectivity/models/data_asset.rb', line 262

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



271
272
273
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 271

def hash
  [key, model_version, model_type, name, description, object_status, object_version, identifier, external_key, asset_properties, properties, type, native_type_system, registry_metadata, metadata, default_connection, end_points].hash
end

#to_hash ⇒ Hash

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/data_connectivity/models/data_asset.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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



309
310
311
 
# File 'lib/oci/data_connectivity/models/data_asset.rb', line 309

def to_s
  to_hash.to_s
end