Class: OCI::AiLanguage::Models::PiiEntityMasking

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_language/models/pii_entity_masking.rb

Overview

Mask recognized PII entities with different modes. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

PiiEntityMask, PiiEntityRemove, PiiEntityReplace

Constant Summary collapse

MODE_ENUM = 
[
  MODE_REPLACE = 'REPLACE'.freeze,
  MODE_MASK = 'MASK'.freeze,
  MODE_REMOVE = 'REMOVE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PiiEntityMasking

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :mode (String) —

    The value to assign to the #mode property

  • :exclude (Array<String>) —

    The value to assign to the #exclude property

  • :should_detect (BOOLEAN) —

    The value to assign to the #should_detect property



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/ai_language/models/pii_entity_masking.rb', line 78

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

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

  self.should_detect = attributes[:'shouldDetect'] unless attributes[:'shouldDetect'].nil?
  self.should_detect = true if should_detect.nil? && !attributes.key?(:'shouldDetect') # rubocop:disable Style/StringLiterals

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

  self.should_detect = attributes[:'should_detect'] unless attributes[:'should_detect'].nil?
  self.should_detect = true if should_detect.nil? && !attributes.key?(:'shouldDetect') && !attributes.key?(:'should_detect') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#exclude ⇒ Array<String>

List of offsets/entities to be removed from anonymization.

Returns:

  • (Array<String>) 


24
25
26
 
# File 'lib/oci/ai_language/models/pii_entity_masking.rb', line 24

def exclude
  @exclude
end

#mode ⇒ String

[Required] The type of masking mode.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/ai_language/models/pii_entity_masking.rb', line 20

def mode
  @mode
end

#should_detect ⇒ BOOLEAN

To include excluded entities from masking in detected entities or not.

Returns:

  • (BOOLEAN) 


28
29
30
 
# File 'lib/oci/ai_language/models/pii_entity_masking.rb', line 28

def should_detect
  @should_detect
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'mode': :'mode',
    'exclude': :'exclude',
    'should_detect': :'shouldDetect'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/ai_language/models/pii_entity_masking.rb', line 57

def self.get_subtype(object_hash)
  type = object_hash[:'mode'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::AiLanguage::Models::PiiEntityReplace' if type == 'REPLACE'
  return 'OCI::AiLanguage::Models::PiiEntityRemove' if type == 'REMOVE'
  return 'OCI::AiLanguage::Models::PiiEntityMask' if type == 'MASK'

  # TODO: Log a warning when the subtype is not found.
  'OCI::AiLanguage::Models::PiiEntityMasking'
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'mode': :'String',
    'exclude': :'Array<String>',
    'should_detect': :'BOOLEAN'
    # 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



112
113
114
115
116
117
118
119
 
# File 'lib/oci/ai_language/models/pii_entity_masking.rb', line 112

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

  self.class == other.class &&
    mode == other.mode &&
    exclude == other.exclude &&
    should_detect == other.should_detect
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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/ai_language/models/pii_entity_masking.rb', line 144

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


124
125
126
 
# File 'lib/oci/ai_language/models/pii_entity_masking.rb', line 124

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



133
134
135
 
# File 'lib/oci/ai_language/models/pii_entity_masking.rb', line 133

def hash
  [mode, exclude, should_detect].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/ai_language/models/pii_entity_masking.rb', line 177

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



171
172
173
 
# File 'lib/oci/ai_language/models/pii_entity_masking.rb', line 171

def to_s
  to_hash.to_s
end