Class: OCI::DataIntegration::Models::DerivedEntity

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

Overview

The Derive entity object

Constant Summary collapse

MODE_ENUM = 
[
  MODE_IN = 'IN'.freeze,
  MODE_OUT = 'OUT'.freeze,
  MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from DataEntity

OCI::DataIntegration::Models::DataEntity::MODEL_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DataEntity

#metadata, #model_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DataEntity

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DerivedEntity

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



134
135
136
137
138
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
 
# File 'lib/oci/data_integration/models/derived_entity.rb', line 134

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

  attributes['modelType'] = 'DERIVED_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.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.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.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.ref_data_object = attributes[:'refDataObject'] if attributes[:'refDataObject']

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

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

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

  self.derived_properties = attributes[:'derivedProperties'] if attributes[:'derivedProperties']

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

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

Instance Attribute Details

#derived_properties ⇒ Hash<String, Object>

Property-bag (key-value pairs where key is Shape Field resource name and value is object)

Returns:

  • (Hash<String, Object>) 


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

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


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

def identifier
  @identifier
end

#key ⇒ String

The object key.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_integration/models/derived_entity.rb', line 21

def key
  @key
end

#mode ⇒ String

Determines whether entity is treated as source or target

Returns:

  • (String) 


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

def mode
  @mode
end

#model_version ⇒ String

The object's model version.

Returns:

  • (String) 


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

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) 


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

def name
  @name
end

#object_status ⇒ Integer

The status of an object that can be set to value 1 for shallow reference across objects, other values reserved.

Returns:

  • (Integer) 


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

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) 


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

def object_version
  @object_version
end

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

Returns:



28
29
30
 
# File 'lib/oci/data_integration/models/derived_entity.rb', line 28

def parent_ref
  @parent_ref
end

#ref_data_object ⇒ OCI::DataIntegration::Models::ReferencedDataObject

Returns:



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

def ref_data_object
  @ref_data_object
end

#resource_name ⇒ String

The resource name.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/data_integration/models/derived_entity.rb', line 47

def resource_name
  @resource_name
end

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

Returns:



39
40
41
 
# File 'lib/oci/data_integration/models/derived_entity.rb', line 39

def shape
  @shape
end

#shape_id ⇒ String

The shape ID.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/data_integration/models/derived_entity.rb', line 43

def shape_id
  @shape_id
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/data_integration/models/derived_entity.rb', line 69

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'metadata': :'metadata',
    'key': :'key',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'name': :'name',
    'object_version': :'objectVersion',
    'shape': :'shape',
    'shape_id': :'shapeId',
    'resource_name': :'resourceName',
    'object_status': :'objectStatus',
    'identifier': :'identifier',
    'ref_data_object': :'refDataObject',
    'mode': :'mode',
    'derived_properties': :'derivedProperties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    'object_version': :'Integer',
    'shape': :'OCI::DataIntegration::Models::Shape',
    'shape_id': :'String',
    'resource_name': :'String',
    'object_status': :'Integer',
    'identifier': :'String',
    'ref_data_object': :'OCI::DataIntegration::Models::ReferencedDataObject',
    'mode': :'String',
    'derived_properties': :'Hash<String, Object>'
    # 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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/oci/data_integration/models/derived_entity.rb', line 223

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 &&
    object_version == other.object_version &&
    shape == other.shape &&
    shape_id == other.shape_id &&
    resource_name == other.resource_name &&
    object_status == other.object_status &&
    identifier == other.identifier &&
    ref_data_object == other.ref_data_object &&
    mode == other.mode &&
    derived_properties == other.derived_properties
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



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

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


247
248
249
 
# File 'lib/oci/data_integration/models/derived_entity.rb', line 247

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



256
257
258
 
# File 'lib/oci/data_integration/models/derived_entity.rb', line 256

def hash
  [model_type, metadata, key, model_version, parent_ref, name, object_version, shape, shape_id, resource_name, object_status, identifier, ref_data_object, mode, derived_properties].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



300
301
302
303
304
305
306
307
308
309
 
# File 'lib/oci/data_integration/models/derived_entity.rb', line 300

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



294
295
296
 
# File 'lib/oci/data_integration/models/derived_entity.rb', line 294

def to_s
  to_hash.to_s
end