Class: OCI::DataSafe::Models::CreateLibraryMaskingFormatDetails

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

Overview

Details to create a library masking format, which can have one or more format entries. A format entry can be a basic masking format such as Random Number, or it can be a library masking format. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking. Note that you cannot define masking condition in a library masking format.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateLibraryMaskingFormatDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



95
96
97
98
99
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
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 95

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

  self.sensitive_type_ids = attributes[:'sensitiveTypeIds'] if attributes[:'sensitiveTypeIds']

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

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

  self.format_entries = attributes[:'formatEntries'] if attributes[:'formatEntries']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment where the library masking format should be created.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 23

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


50
51
52
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 50

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the library masking format.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

The display name of the library masking format. The name does not have to be unique, and it's changeable.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 19

def display_name
  @display_name
end

#format_entries ⇒ Array<OCI::DataSafe::Models::FormatEntry>

[Required] An array of format entries. The combined output of all the format entries is used for masking.

Returns:



36
37
38
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 36

def format_entries
  @format_entries
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


43
44
45
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 43

def freeform_tags
  @freeform_tags
end

#sensitive_type_ids ⇒ Array<String>

An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

Returns:

  • (Array<String>) 


32
33
34
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 32

def sensitive_type_ids
  @sensitive_type_ids
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'description': :'description',
    'sensitive_type_ids': :'sensitiveTypeIds',
    'format_entries': :'formatEntries',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'description': :'String',
    'sensitive_type_ids': :'Array<String>',
    'format_entries': :'Array<OCI::DataSafe::Models::FormatEntry>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 147

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    sensitive_type_ids == other.sensitive_type_ids &&
    format_entries == other.format_entries &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 183

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


163
164
165
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 163

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



172
173
174
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 172

def hash
  [display_name, compartment_id, description, sensitive_type_ids, format_entries, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 216

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



210
211
212
 
# File 'lib/oci/data_safe/models/create_library_masking_format_details.rb', line 210

def to_s
  to_hash.to_s
end