Class: OCI::DataIntegration::Models::CreateEntityShapeFromObject

Inherits:
CreateEntityShapeDetails show all
Defined in:
lib/oci/data_integration/models/create_entity_shape_from_object.rb

Overview

The application object 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_SQL = 'SQL'.freeze,
  ENTITY_TYPE_OBJECT = 'OBJECT'.freeze
].freeze

Constants inherited from CreateEntityShapeDetails

OCI::DataIntegration::Models::CreateEntityShapeDetails::MODEL_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateEntityShapeDetails

#model_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateEntityShapeDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateEntityShapeFromObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



139
140
141
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
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
 
# File 'lib/oci/data_integration/models/create_entity_shape_from_object.rb', line 139

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

  attributes['modelType'] = 'OBJECT_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.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.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.entity_type = attributes[:'entityType'] if attributes[:'entityType']
  self.entity_type = "OBJECT" if entity_type.nil? && !attributes.key?(:'entityType') # rubocop:disable Style/StringLiterals

  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.entity_type = "OBJECT" if entity_type.nil? && !attributes.key?(:'entityType') && !attributes.key?(:'entity_type') # rubocop:disable Style/StringLiterals

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

Instance Attribute Details

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

Returns:



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

def data_format
  @data_format
end

#description ⇒ String

Detailed description for the object.

Returns:

  • (String) 


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

def description
  @description
end

#entity_type ⇒ String

The entity type.

Returns:

  • (String) 


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

def entity_type
  @entity_type
end

#external_key ⇒ String

The external key for the object.

Returns:

  • (String) 


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

def external_key
  @external_key
end

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

An array of foreign keys.

Returns:



60
61
62
 
# File 'lib/oci/data_integration/models/create_entity_shape_from_object.rb', line 60

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) 


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

def identifier
  @identifier
end

#key ⇒ String

The object key.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/data_integration/models/create_entity_shape_from_object.rb', line 22

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


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

def name
  @name
end

#other_type_label ⇒ String

Specifies other type label.

Returns:

  • (String) 


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

def other_type_label
  @other_type_label
end

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

Returns:



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

def parent_ref
  @parent_ref
end

#resource_name ⇒ String

The resource name.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/data_integration/models/create_entity_shape_from_object.rb', line 64

def resource_name
  @resource_name
end

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

Returns:



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

def shape
  @shape
end

#shape_id ⇒ String

The shape ID.

Returns:

  • (String) 


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

def shape_id
  @shape_id
end

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

An array of unique keys.

Returns:



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

def unique_keys
  @unique_keys
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/data_integration/models/create_entity_shape_from_object.rb', line 74

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'key': :'key',
    'parent_ref': :'parentRef',
    'name': :'name',
    'description': :'description',
    'external_key': :'externalKey',
    'shape': :'shape',
    'shape_id': :'shapeId',
    'entity_type': :'entityType',
    'other_type_label': :'otherTypeLabel',
    'unique_keys': :'uniqueKeys',
    'foreign_keys': :'foreignKeys',
    'resource_name': :'resourceName',
    'data_format': :'dataFormat',
    'identifier': :'identifier'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/create_entity_shape_from_object.rb', line 97

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'key': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'name': :'String',
    'description': :'String',
    'external_key': :'String',
    'shape': :'OCI::DataIntegration::Models::Shape',
    'shape_id': :'String',
    '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',
    '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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/data_integration/models/create_entity_shape_from_object.rb', line 231

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

  self.class == other.class &&
    model_type == other.model_type &&
    key == other.key &&
    parent_ref == other.parent_ref &&
    name == other.name &&
    description == other.description &&
    external_key == other.external_key &&
    shape == other.shape &&
    shape_id == other.shape_id &&
    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 &&
    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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/data_integration/models/create_entity_shape_from_object.rb', line 275

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


255
256
257
 
# File 'lib/oci/data_integration/models/create_entity_shape_from_object.rb', line 255

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



264
265
266
 
# File 'lib/oci/data_integration/models/create_entity_shape_from_object.rb', line 264

def hash
  [model_type, key, parent_ref, name, description, external_key, shape, shape_id, entity_type, other_type_label, unique_keys, foreign_keys, resource_name, data_format, identifier].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



308
309
310
311
312
313
314
315
316
317
 
# File 'lib/oci/data_integration/models/create_entity_shape_from_object.rb', line 308

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



302
303
304
 
# File 'lib/oci/data_integration/models/create_entity_shape_from_object.rb', line 302

def to_s
  to_hash.to_s
end