Class: OCI::DataIntegration::Models::FunctionSignature

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

Overview

The function signature can specify function paramaters and/or function return type.

Constant Summary collapse

MODEL_TYPE_ENUM = 
[
  MODEL_TYPE_DIS_FUNCTION_SIGNATURE = 'DIS_FUNCTION_SIGNATURE'.freeze,
  MODEL_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FunctionSignature

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 100

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

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

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

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

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

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

Instance Attribute Details

#arguments ⇒ Array<OCI::DataIntegration::Models::TypedObject>

An array of function arguments.

Returns:



41
42
43
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 41

def arguments
  @arguments
end

#description ⇒ String

Detailed description for the object.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 45

def description
  @description
end

#key ⇒ String

The key of the object.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 19

def key
  @key
end

#model_type ⇒ String

The type of the object.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 23

def model_type
  @model_type
end

#model_version ⇒ String

The model version of an object.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 27

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) 


34
35
36
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 34

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) 


49
50
51
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 49

def object_status
  @object_status
end

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

Returns:



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

def parent_ref
  @parent_ref
end

#ret_type ⇒ OCI::DataIntegration::Models::ConfiguredType

Returns:



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

def ret_type
  @ret_type
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 52

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'model_type': :'modelType',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'name': :'name',
    'ret_type': :'retType',
    'arguments': :'arguments',
    'description': :'description',
    'object_status': :'objectStatus'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'model_type': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'name': :'String',
    'ret_type': :'OCI::DataIntegration::Models::ConfiguredType',
    'arguments': :'Array<OCI::DataIntegration::Models::TypedObject>',
    'description': :'String',
    'object_status': :'Integer'
    # 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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 165

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 &&
    ret_type == other.ret_type &&
    arguments == other.arguments &&
    description == other.description &&
    object_status == other.object_status
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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 203

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


183
184
185
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 183

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



192
193
194
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 192

def hash
  [key, model_type, model_version, parent_ref, name, ret_type, arguments, description, object_status].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 236

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



230
231
232
 
# File 'lib/oci/data_integration/models/function_signature.rb', line 230

def to_s
  to_hash.to_s
end