Class: OCI::DataIntegration::Models::DataEntitySummaryFromDataStore

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

Overview

The view entity data entity details.

Constant Summary collapse

ENTITY_TYPE_ENUM = 
[
  ENTITY_TYPE_TABLE = 'TABLE'.freeze,
  ENTITY_TYPE_VIEW = 'VIEW'.freeze,
  ENTITY_TYPE_FILE = 'FILE'.freeze,
  ENTITY_TYPE_QUEUE = 'QUEUE'.freeze,
  ENTITY_TYPE_STREAM = 'STREAM'.freeze,
  ENTITY_TYPE_OTHER = 'OTHER'.freeze,
  ENTITY_TYPE_DATA_STORE = 'DATA_STORE'.freeze,
  ENTITY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from DataEntitySummary

OCI::DataIntegration::Models::DataEntitySummary::MODEL_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DataEntitySummary

#metadata, #model_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DataEntitySummary

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DataEntitySummaryFromDataStore

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 202

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['modelType'] = 'DATA_STORE_ENTITY'

  super(attributes)

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

  self.shape_id = attributes[:'shapeId'] if attributes[:'shapeId']

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

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

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

  self.entity_type = attributes[:'entityType'] if attributes[:'entityType']

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

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

  self.other_type_label = attributes[:'otherTypeLabel'] if attributes[:'otherTypeLabel']

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

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

  self.unique_keys = attributes[:'uniqueKeys'] if attributes[:'uniqueKeys']

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

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

  self.foreign_keys = attributes[:'foreignKeys'] if attributes[:'foreignKeys']

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

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

  self.resource_name = attributes[:'resourceName'] if attributes[:'resourceName']

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

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

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

  self.is_effective_date_disabled = attributes[:'isEffectiveDateDisabled'] unless attributes[:'isEffectiveDateDisabled'].nil?

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

  self.is_effective_date_disabled = attributes[:'is_effective_date_disabled'] unless attributes[:'is_effective_date_disabled'].nil?

  self.is_flex_data_store = attributes[:'isFlexDataStore'] unless attributes[:'isFlexDataStore'].nil?

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

  self.is_flex_data_store = attributes[:'is_flex_data_store'] unless attributes[:'is_flex_data_store'].nil?

  self.is_silent_error = attributes[:'isSilentError'] unless attributes[:'isSilentError'].nil?

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

  self.is_silent_error = attributes[:'is_silent_error'] unless attributes[:'is_silent_error'].nil?

  self.supports_incremental = attributes[:'supportsIncremental'] unless attributes[:'supportsIncremental'].nil?

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

  self.supports_incremental = attributes[:'supports_incremental'] unless attributes[:'supports_incremental'].nil?
end

Instance Attribute Details

#description ⇒ String

Detailed description for the object.

Returns:

  • (String) 


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

def description
  @description
end

#entity_type ⇒ String

The entity type.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 63

def entity_type
  @entity_type
end

#external_key ⇒ String

The external key for the object

Returns:

  • (String) 


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

def external_key
  @external_key
end

#filters ⇒ String

Query filter for the extract. It can be Null.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 91

def filters
  @filters
end

#foreign_keys ⇒ Array<OCI::DataIntegration::Models::ForeignKey>

An array of foreign keys.

Returns:



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

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


87
88
89
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 87

def identifier
  @identifier
end

#is_effective_date_disabled ⇒ BOOLEAN

It shows whether or not effective date is disabled

Returns:

  • (BOOLEAN) 


95
96
97
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 95

def is_effective_date_disabled
  @is_effective_date_disabled
end

#is_flex_data_store ⇒ BOOLEAN

Is Flex data store. Metadata csv will be generated for flex data store

Returns:

  • (BOOLEAN) 


99
100
101
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 99

def is_flex_data_store
  @is_flex_data_store
end

#is_silent_error ⇒ BOOLEAN

Should the VO failure fail the whole batch?

Returns:

  • (BOOLEAN) 


103
104
105
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 103

def is_silent_error
  @is_silent_error
end

#key ⇒ String

The object key.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 26

def key
  @key
end

#model_version ⇒ String

The object's model version.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 30

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) 


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

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) 


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

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) 


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

def object_version
  @object_version
end

#other_type_label ⇒ String

Specifies other type label.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 67

def other_type_label
  @other_type_label
end

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

Returns:



33
34
35
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 33

def parent_ref
  @parent_ref
end

#resource_name ⇒ String

The resource name.

Returns:

  • (String) 


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

def resource_name
  @resource_name
end

#shape ⇒ OCI::DataIntegration::Models::Shape

Returns:



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

def shape
  @shape
end

#shape_id ⇒ String

The shape ID.

Returns:

  • (String) 


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

def shape_id
  @shape_id
end

#supports_incremental ⇒ BOOLEAN

It shows whether the datastore supports Incremental Extract or not.

Returns:

  • (BOOLEAN) 


107
108
109
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 107

def supports_incremental
  @supports_incremental
end

#types ⇒ OCI::DataIntegration::Models::TypeLibrary

Returns:



59
60
61
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 59

def types
  @types
end

#unique_keys ⇒ Array<OCI::DataIntegration::Models::UniqueKey>

An array of unique keys.

Returns:



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

def unique_keys
  @unique_keys
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'metadata': :'metadata',
    'key': :'key',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'name': :'name',
    'description': :'description',
    'object_version': :'objectVersion',
    'external_key': :'externalKey',
    'shape': :'shape',
    'shape_id': :'shapeId',
    'types': :'types',
    'entity_type': :'entityType',
    'other_type_label': :'otherTypeLabel',
    'unique_keys': :'uniqueKeys',
    'foreign_keys': :'foreignKeys',
    'resource_name': :'resourceName',
    'object_status': :'objectStatus',
    'identifier': :'identifier',
    'filters': :'filters',
    'is_effective_date_disabled': :'isEffectiveDateDisabled',
    'is_flex_data_store': :'isFlexDataStore',
    'is_silent_error': :'isSilentError',
    'supports_incremental': :'supportsIncremental'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 142

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'metadata': :'OCI::DataIntegration::Models::ObjectMetadata',
    'key': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'name': :'String',
    'description': :'String',
    'object_version': :'Integer',
    'external_key': :'String',
    'shape': :'OCI::DataIntegration::Models::Shape',
    'shape_id': :'String',
    'types': :'OCI::DataIntegration::Models::TypeLibrary',
    'entity_type': :'String',
    'other_type_label': :'String',
    'unique_keys': :'Array<OCI::DataIntegration::Models::UniqueKey>',
    'foreign_keys': :'Array<OCI::DataIntegration::Models::ForeignKey>',
    'resource_name': :'String',
    'object_status': :'Integer',
    'identifier': :'String',
    'filters': :'String',
    'is_effective_date_disabled': :'BOOLEAN',
    'is_flex_data_store': :'BOOLEAN',
    'is_silent_error': :'BOOLEAN',
    'supports_incremental': :'BOOLEAN'
    # 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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 337

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

  self.class == other.class &&
    model_type == other.model_type &&
    metadata == other.metadata &&
    key == other.key &&
    model_version == other.model_version &&
    parent_ref == other.parent_ref &&
    name == other.name &&
    description == other.description &&
    object_version == other.object_version &&
    external_key == other.external_key &&
    shape == other.shape &&
    shape_id == other.shape_id &&
    types == other.types &&
    entity_type == other.entity_type &&
    other_type_label == other.other_type_label &&
    unique_keys == other.unique_keys &&
    foreign_keys == other.foreign_keys &&
    resource_name == other.resource_name &&
    object_status == other.object_status &&
    identifier == other.identifier &&
    filters == other.filters &&
    is_effective_date_disabled == other.is_effective_date_disabled &&
    is_flex_data_store == other.is_flex_data_store &&
    is_silent_error == other.is_silent_error &&
    supports_incremental == other.supports_incremental
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



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 390

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


370
371
372
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 370

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



379
380
381
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 379

def hash
  [model_type, metadata, key, model_version, parent_ref, name, description, object_version, external_key, shape, shape_id, types, entity_type, other_type_label, unique_keys, foreign_keys, resource_name, object_status, identifier, filters, is_effective_date_disabled, is_flex_data_store, is_silent_error, supports_incremental].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



423
424
425
426
427
428
429
430
431
432
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 423

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



417
418
419
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_data_store.rb', line 417

def to_s
  to_hash.to_s
end