Class: OCI::DataIntegration::Models::OciFunction

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

Overview

The information about the OCI Function.

Constant Summary collapse

MODEL_TYPE_ENUM = 
[
  MODEL_TYPE_OCI_FUNCTION = 'OCI_FUNCTION'.freeze,
  MODEL_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PAYLOAD_FORMAT_ENUM = 
[
  PAYLOAD_FORMAT_JSON = 'JSON'.freeze,
  PAYLOAD_FORMAT_AVRO = 'AVRO'.freeze,
  PAYLOAD_FORMAT_JSONBYTES = 'JSONBYTES'.freeze,
  PAYLOAD_FORMAT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OciFunction

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



125
126
127
128
129
130
131
132
133
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
202
 
# File 'lib/oci/data_integration/models/oci_function.rb', line 125

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

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.function_id = attributes[:'functionId'] if attributes[:'functionId']

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

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

  self.region_id = attributes[:'regionId'] if attributes[:'regionId']

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

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

  self.fn_config_definition = attributes[:'fnConfigDefinition'] if attributes[:'fnConfigDefinition']

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

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

  self.input_shape = attributes[:'inputShape'] if attributes[:'inputShape']

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

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

  self.output_shape = attributes[:'outputShape'] if attributes[:'outputShape']

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

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

  self.model_type = attributes[:'modelType'] if attributes[:'modelType']
  self.model_type = "OCI_FUNCTION" if model_type.nil? && !attributes.key?(:'modelType') # rubocop:disable Style/StringLiterals

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

  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.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.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.payload_format = attributes[:'payloadFormat'] if attributes[:'payloadFormat']
  self.payload_format = "JSON" if payload_format.nil? && !attributes.key?(:'payloadFormat') # rubocop:disable Style/StringLiterals

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

  self.payload_format = attributes[:'payload_format'] if attributes[:'payload_format']
  self.payload_format = "JSON" if payload_format.nil? && !attributes.key?(:'payloadFormat') && !attributes.key?(:'payload_format') # rubocop:disable Style/StringLiterals

  self.fn_config_def = attributes[:'fnConfigDef'] if attributes[:'fnConfigDef']

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

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

Instance Attribute Details

#fn_config_def ⇒ OCI::DataIntegration::Models::FunctionConfigurationDefinition

Returns:



65
66
67
 
# File 'lib/oci/data_integration/models/oci_function.rb', line 65

def fn_config_def
  @fn_config_def
end

#fn_config_definition ⇒ OCI::DataIntegration::Models::ConfigDefinition

Returns:



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

def fn_config_definition
  @fn_config_definition
end

#function_id ⇒ String

Ocid of the OCI Function.

Returns:

  • (String) 


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

def function_id
  @function_id
end

#input_shape ⇒ OCI::DataIntegration::Models::Shape

Returns:



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

def input_shape
  @input_shape
end

#key ⇒ String

The key identifying the OCI Function operator object, use this to identiy this instance within the dataflow.

Returns:

  • (String) 


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

def key
  @key
end

#model_type ⇒ String

The type of the OCI Function object.

Returns:

  • (String) 


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

def model_type
  @model_type
end

#model_version ⇒ String

The model version of an object.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/data_integration/models/oci_function.rb', line 54

def model_version
  @model_version
end

#object_version ⇒ Integer

The version of the object that is used to track changes in the object instance.

Returns:

  • (Integer) 


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

def object_version
  @object_version
end

#output_shape ⇒ OCI::DataIntegration::Models::Shape

Returns:



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

def output_shape
  @output_shape
end

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

Returns:



50
51
52
 
# File 'lib/oci/data_integration/models/oci_function.rb', line 50

def parent_ref
  @parent_ref
end

#payload_format ⇒ String

The OCI Function payload format.

Returns:

  • (String) 


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

def payload_format
  @payload_format
end

#region_id ⇒ String

Region where the OCI Function is deployed.

Returns:

  • (String) 


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

def region_id
  @region_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'function_id': :'functionId',
    'region_id': :'regionId',
    'fn_config_definition': :'fnConfigDefinition',
    'input_shape': :'inputShape',
    'output_shape': :'outputShape',
    'model_type': :'modelType',
    'key': :'key',
    'parent_ref': :'parentRef',
    'model_version': :'modelVersion',
    'object_version': :'objectVersion',
    'payload_format': :'payloadFormat',
    'fn_config_def': :'fnConfigDef'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/data_integration/models/oci_function.rb', line 88

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'function_id': :'String',
    'region_id': :'String',
    'fn_config_definition': :'OCI::DataIntegration::Models::ConfigDefinition',
    'input_shape': :'OCI::DataIntegration::Models::Shape',
    'output_shape': :'OCI::DataIntegration::Models::Shape',
    'model_type': :'String',
    'key': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'model_version': :'String',
    'object_version': :'Integer',
    'payload_format': :'String',
    'fn_config_def': :'OCI::DataIntegration::Models::FunctionConfigurationDefinition'
    # 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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/data_integration/models/oci_function.rb', line 237

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

  self.class == other.class &&
    function_id == other.function_id &&
    region_id == other.region_id &&
    fn_config_definition == other.fn_config_definition &&
    input_shape == other.input_shape &&
    output_shape == other.output_shape &&
    model_type == other.model_type &&
    key == other.key &&
    parent_ref == other.parent_ref &&
    model_version == other.model_version &&
    object_version == other.object_version &&
    payload_format == other.payload_format &&
    fn_config_def == other.fn_config_def
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



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

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


258
259
260
 
# File 'lib/oci/data_integration/models/oci_function.rb', line 258

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



267
268
269
 
# File 'lib/oci/data_integration/models/oci_function.rb', line 267

def hash
  [function_id, region_id, fn_config_definition, input_shape, output_shape, model_type, key, parent_ref, model_version, object_version, payload_format, fn_config_def].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



311
312
313
314
315
316
317
318
319
320
 
# File 'lib/oci/data_integration/models/oci_function.rb', line 311

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



305
306
307
 
# File 'lib/oci/data_integration/models/oci_function.rb', line 305

def to_s
  to_hash.to_s
end