Class: OCI::DataIntegration::Models::UserDefinedFunctionSummary

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

Overview

The user defined function summary type contains the audit summary information and the definition of the user defined function.

Constant Summary collapse

MODEL_TYPE_ENUM = 
[
  MODEL_TYPE_DIS_USER_DEFINED_FUNCTION = 'DIS_USER_DEFINED_FUNCTION'.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 = {}) ⇒ UserDefinedFunctionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

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

Instance Attribute Details

#description ⇒ String

Detailed description for the object.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/data_integration/models/user_defined_function_summary.rb', line 53

def description
  @description
end

#expr ⇒ OCI::DataIntegration::Models::Expression

Returns:



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

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


38
39
40
 
# File 'lib/oci/data_integration/models/user_defined_function_summary.rb', line 38

def identifier
  @identifier
end

#key ⇒ String

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

Returns:

  • (String) 


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

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>) 


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

def key_map
  @key_map
end

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

Returns:



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

def metadata
  @metadata
end

#model_type ⇒ String

The type of the object.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/data_integration/models/user_defined_function_summary.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/user_defined_function_summary.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/user_defined_function_summary.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) 


57
58
59
 
# File 'lib/oci/data_integration/models/user_defined_function_summary.rb', line 57

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) 


42
43
44
 
# File 'lib/oci/data_integration/models/user_defined_function_summary.rb', line 42

def object_version
  @object_version
end

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

Returns:



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

def parent_ref
  @parent_ref
end

#signatures ⇒ Array<OCI::DataIntegration::Models::FunctionSignature>

An array of function signature.

Returns:



46
47
48
 
# File 'lib/oci/data_integration/models/user_defined_function_summary.rb', line 46

def signatures
  @signatures
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    'signatures': :'signatures',
    'expr': :'expr',
    'description': :'description',
    'object_status': :'objectStatus',
    'metadata': :'metadata',
    'key_map': :'keyMap'
    # 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
106
 
# File 'lib/oci/data_integration/models/user_defined_function_summary.rb', line 88

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',
    'signatures': :'Array<OCI::DataIntegration::Models::FunctionSignature>',
    'expr': :'OCI::DataIntegration::Models::Expression',
    'description': :'String',
    'object_status': :'Integer',
    'metadata': :'OCI::DataIntegration::Models::ObjectMetadata',
    'key_map': :'Hash<String, 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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/data_integration/models/user_defined_function_summary.rb', line 201

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 &&
    signatures == other.signatures &&
    expr == other.expr &&
    description == other.description &&
    object_status == other.object_status &&
    metadata == other.metadata &&
    key_map == other.key_map
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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/oci/data_integration/models/user_defined_function_summary.rb', line 243

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


223
224
225
 
# File 'lib/oci/data_integration/models/user_defined_function_summary.rb', line 223

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



232
233
234
 
# File 'lib/oci/data_integration/models/user_defined_function_summary.rb', line 232

def hash
  [key, model_type, model_version, parent_ref, name, identifier, object_version, signatures, expr, description, object_status, metadata, key_map].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



276
277
278
279
280
281
282
283
284
285
 
# File 'lib/oci/data_integration/models/user_defined_function_summary.rb', line 276

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



270
271
272
 
# File 'lib/oci/data_integration/models/user_defined_function_summary.rb', line 270

def to_s
  to_hash.to_s
end