Class: OCI::DataIntegration::Models::DataEntitySummaryFromFile

Inherits:
DataEntitySummary show all
Defined in:
lib/oci/data_integration/models/data_entity_summary_from_file.rb

Overview

The file 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_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 = {}) ⇒ DataEntitySummaryFromFile

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

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

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

Instance Attribute Details

#data_format ⇒ OCI::DataIntegration::Models::DataFormat

Returns:



81
82
83
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 81

def data_format
  @data_format
end

#description ⇒ String

Detailed description for the object.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 40

def description
  @description
end

#entity_type ⇒ String

The entity type.

Returns:

  • (String) 


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

def entity_type
  @entity_type
end

#external_key ⇒ String

The external key for the object.

Returns:

  • (String) 


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

def external_key
  @external_key
end

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

An array of foreign keys.

Returns:



74
75
76
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 74

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) 


89
90
91
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 89

def identifier
  @identifier
end

#key ⇒ String

The object key.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 25

def key
  @key
end

#model_version ⇒ String

The object's model version.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 29

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) 


36
37
38
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 36

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) 


85
86
87
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 85

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) 


44
45
46
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 44

def object_version
  @object_version
end

#other_type_label ⇒ String

Specifies other type label.

Returns:

  • (String) 


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

def other_type_label
  @other_type_label
end

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

Returns:



32
33
34
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 32

def parent_ref
  @parent_ref
end

#resource_name ⇒ String

The resource name.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 78

def resource_name
  @resource_name
end

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

Returns:



51
52
53
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 51

def shape
  @shape
end

#shape_id ⇒ String

The shape ID.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 55

def shape_id
  @shape_id
end

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

Returns:



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

def types
  @types
end

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

An array of unique keys.

Returns:



70
71
72
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 70

def unique_keys
  @unique_keys
end

Class Method Details

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 92

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',
    'data_format': :'dataFormat',
    'object_status': :'objectStatus',
    'identifier': :'identifier'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 120

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',
    'data_format': :'OCI::DataIntegration::Models::DataFormat',
    'object_status': :'Integer',
    'identifier': :'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



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

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 &&
    data_format == other.data_format &&
    object_status == other.object_status &&
    identifier == other.identifier
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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 336

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


316
317
318
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 316

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



325
326
327
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 325

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, data_format, object_status, identifier].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



369
370
371
372
373
374
375
376
377
378
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 369

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



363
364
365
 
# File 'lib/oci/data_integration/models/data_entity_summary_from_file.rb', line 363

def to_s
  to_hash.to_s
end