Class: OCI::DataSafe::Models::RegularExpressionFormatEntry

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

Overview

The Regular Expression masking format gives the flexibility to use regular expressions to search for sensitive data in a column of Large Object data type (LOB), and replace the data with a fixed string, fixed number, null value, or SQL expression. It can also be used for columns of VARCHAR2 type to mask parts of strings. To learn more, check Regular Expressions 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 = {}) ⇒ RegularExpressionFormatEntry

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

  • :regular_expression (String) —

    The value to assign to the #regular_expression property

  • :replace_with (String) —

    The value to assign to the #replace_with property



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/data_safe/models/regular_expression_format_entry.rb', line 62

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

  attributes['type'] = 'REGULAR_EXPRESSION'

  super(attributes)

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

  self.regular_expression = attributes[:'regularExpression'] if attributes[:'regularExpression']

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

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

  self.replace_with = attributes[:'replaceWith'] if attributes[:'replaceWith']

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

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

Instance Attribute Details

#regular_expression ⇒ String

[Required] The pattern that should be used to search for data.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/data_safe/models/regular_expression_format_entry.rb', line 20

def regular_expression
  @regular_expression
end

#replace_with ⇒ String

[Required] The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number, null value, or SQL expression.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/data_safe/models/regular_expression_format_entry.rb', line 27

def replace_with
  @replace_with
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/oci/data_safe/models/regular_expression_format_entry.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'description': :'description',
    'regular_expression': :'regularExpression',
    'replace_with': :'replaceWith'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/data_safe/models/regular_expression_format_entry.rb', line 42

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



92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/data_safe/models/regular_expression_format_entry.rb', line 92

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

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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/data_safe/models/regular_expression_format_entry.rb', line 125

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


105
106
107
 
# File 'lib/oci/data_safe/models/regular_expression_format_entry.rb', line 105

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



114
115
116
 
# File 'lib/oci/data_safe/models/regular_expression_format_entry.rb', line 114

def hash
  [type, description, regular_expression, replace_with].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/data_safe/models/regular_expression_format_entry.rb', line 158

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



152
153
154
 
# File 'lib/oci/data_safe/models/regular_expression_format_entry.rb', line 152

def to_s
  to_hash.to_s
end