Class: OCI::DataSafe::Models::UDFFormatEntry

Inherits:
FormatEntry
  • Object
show all
Defined in:
lib/oci/data_safe/models/udf_format_entry.rb

Overview

The User Defined Function masking format lets you define your own logic to mask column data. The return value of the user-defined function is used to replace the original values. The user-defined function has a fixed signature and is a PL/SQL function that can be invoked in a SELECT statement. To learn more, check User Defined Function in the Data Safe documentation.

Constant Summary

Constants inherited from FormatEntry

FormatEntry::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from FormatEntry

#description, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from FormatEntry

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UDFFormatEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :description (String) —

    The value to assign to the #description proprety

  • :user_defined_function (String) —

    The value to assign to the #user_defined_function property



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/data_safe/models/udf_format_entry.rb', line 53

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

  attributes['type'] = 'USER_DEFINED_FUNCTION'

  super(attributes)

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

  self.user_defined_function = attributes[:'userDefinedFunction'] if attributes[:'userDefinedFunction']

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

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

Instance Attribute Details

#user_defined_function ⇒ String

[Required] The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_safe/models/udf_format_entry.rb', line 21

def user_defined_function
  @user_defined_function
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
32
 
# File 'lib/oci/data_safe/models/udf_format_entry.rb', line 24

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'description': :'description',
    'user_defined_function': :'userDefinedFunction'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/data_safe/models/udf_format_entry.rb', line 35

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'description': :'String',
    'user_defined_function': :'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



77
78
79
80
81
82
83
84
 
# File 'lib/oci/data_safe/models/udf_format_entry.rb', line 77

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

  self.class == other.class &&
    type == other.type &&
    description == other.description &&
    user_defined_function == other.user_defined_function
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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/data_safe/models/udf_format_entry.rb', line 109

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


89
90
91
 
# File 'lib/oci/data_safe/models/udf_format_entry.rb', line 89

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



98
99
100
 
# File 'lib/oci/data_safe/models/udf_format_entry.rb', line 98

def hash
  [type, description, user_defined_function].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/data_safe/models/udf_format_entry.rb', line 142

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



136
137
138
 
# File 'lib/oci/data_safe/models/udf_format_entry.rb', line 136

def to_s
  to_hash.to_s
end