Class: OCI::DataIntegration::Models::DataFlowSummary

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

Overview

The data flow summary type contains the audit summary information and the definition of the data flow.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataFlowSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

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

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

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

  self.flow_config_values = attributes[:'flowConfigValues'] if attributes[:'flowConfigValues']

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

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

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

  self.key_map = attributes[:'keyMap'] if attributes[:'keyMap']

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

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

  self.typed_object_map = attributes[:'typedObjectMap'] if attributes[:'typedObjectMap']

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

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

  self.target_field_map_summary = attributes[:'targetFieldMapSummary'] if attributes[:'targetFieldMapSummary']

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

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

Instance Attribute Details

#description ⇒ String

Detailed description for the object.

Returns:

  • (String) 


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

def description
  @description
end

#flow_config_values ⇒ OCI::DataIntegration::Models::ConfigValues

Returns:



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

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


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

def identifier
  @identifier
end

#key ⇒ String

Generated key that can be used in API calls to identify data flow. On scenarios where reference to the data flow is needed, a value can be passed in create.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/data_integration/models/data_flow_summary.rb', line 13

def key
  @key
end

#key_map ⇒ Hash<String, String>

A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.

Returns:

  • (Hash<String, String>) 


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

def key_map
  @key_map
end

#metadata ⇒ OCI::DataIntegration::Models::ObjectMetadata

Returns:



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

def metadata
  @metadata
end

#model_type ⇒ String

The type of the object.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/data_integration/models/data_flow_summary.rb', line 17

def model_type
  @model_type
end

#model_version ⇒ String

The model version of an object.

Returns:

  • (String) 


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

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) 


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

def name
  @name
end

#nodes ⇒ Array<OCI::DataIntegration::Models::FlowNode>

An array of nodes.

Returns:



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

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


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

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/data_flow_summary.rb', line 36

def object_version
  @object_version
end

#parameters ⇒ Array<OCI::DataIntegration::Models::Parameter>

An array of parameters.

Returns:



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

def parameters
  @parameters
end

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

Returns:



24
25
26
 
# File 'lib/oci/data_integration/models/data_flow_summary.rb', line 24

def parent_ref
  @parent_ref
end

#target_field_map_summary ⇒ Hash<String, OCI::DataIntegration::Models::FieldMapWrapper>

A hash map that maps TypedObject keys to a field map that maps to the typed object as a target, for java sdk.

Returns:



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

def target_field_map_summary
  @target_field_map_summary
end

#typed_object_map ⇒ Hash<String, OCI::DataIntegration::Models::TypedObjectWrapper>

A hash map that maps TypedObject keys to the object itself, for java sdk.

Returns:



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

def typed_object_map
  @typed_object_map
end

Class Method Details

.attribute_map ⇒ Object

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



73
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/data_flow_summary.rb', line 73

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'model_type': :'modelType',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'name': :'name',
    'identifier': :'identifier',
    'object_version': :'objectVersion',
    'nodes': :'nodes',
    'parameters': :'parameters',
    'description': :'description',
    'flow_config_values': :'flowConfigValues',
    'object_status': :'objectStatus',
    'metadata': :'metadata',
    'key_map': :'keyMap',
    'typed_object_map': :'typedObjectMap',
    'target_field_map_summary': :'targetFieldMapSummary'
    # 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
118
 
# File 'lib/oci/data_integration/models/data_flow_summary.rb', line 97

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'model_type': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'name': :'String',
    'identifier': :'String',
    'object_version': :'Integer',
    'nodes': :'Array<OCI::DataIntegration::Models::FlowNode>',
    'parameters': :'Array<OCI::DataIntegration::Models::Parameter>',
    'description': :'String',
    'flow_config_values': :'OCI::DataIntegration::Models::ConfigValues',
    'object_status': :'Integer',
    'metadata': :'OCI::DataIntegration::Models::ObjectMetadata',
    'key_map': :'Hash<String, String>',
    'typed_object_map': :'Hash<String, OCI::DataIntegration::Models::TypedObjectWrapper>',
    'target_field_map_summary': :'Hash<String, OCI::DataIntegration::Models::FieldMapWrapper>'
    # 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



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

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

  self.class == other.class &&
    key == other.key &&
    model_type == other.model_type &&
    model_version == other.model_version &&
    parent_ref == other.parent_ref &&
    name == other.name &&
    identifier == other.identifier &&
    object_version == other.object_version &&
    nodes == other.nodes &&
    parameters == other.parameters &&
    description == other.description &&
    flow_config_values == other.flow_config_values &&
    object_status == other.object_status &&
    metadata == other.metadata &&
    key_map == other.key_map &&
    typed_object_map == other.typed_object_map &&
    target_field_map_summary == other.target_field_map_summary
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



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

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


246
247
248
 
# File 'lib/oci/data_integration/models/data_flow_summary.rb', line 246

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [key, model_type, model_version, parent_ref, name, identifier, object_version, nodes, parameters, description, flow_config_values, object_status, metadata, key_map, typed_object_map, target_field_map_summary].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



293
294
295
 
# File 'lib/oci/data_integration/models/data_flow_summary.rb', line 293

def to_s
  to_hash.to_s
end