Class: OCI::DataSafe::Models::UpdateLibraryMaskingFormatDetails

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

Overview

Details to update a library masking format. Note that updating the formatEntries attribute replaces all the existing masking format entries with the specified format entries.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateLibraryMaskingFormatDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



83
84
85
86
87
88
89
90
91
92
93
94
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
# File 'lib/oci/data_safe/models/update_library_masking_format_details.rb', line 83

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

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


41
42
43
# File 'lib/oci/data_safe/models/update_library_masking_format_details.rb', line 41

def defined_tags
  @defined_tags
end

#descriptionString

The description of the library masking format.

Returns:

  • (String)


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

def description
  @description
end

#display_nameString

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

Returns:

  • (String)


15
16
17
# File 'lib/oci/data_safe/models/update_library_masking_format_details.rb', line 15

def display_name
  @display_name
end

#format_entriesArray<OCI::DataSafe::Models::FormatEntry>

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



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

def format_entries
  @format_entries
end

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


34
35
36
# File 'lib/oci/data_safe/models/update_library_masking_format_details.rb', line 34

def freeform_tags
  @freeform_tags
end

#sensitive_type_idsArray<String>

An array of OCIDs of the sensitive types compatible with the library masking format.

Returns:

  • (Array<String>)


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

def sensitive_type_ids
  @sensitive_type_ids
end

Class Method Details

.attribute_mapObject

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



44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/oci/data_safe/models/update_library_masking_format_details.rb', line 44

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

.swagger_typesObject

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/oci/data_safe/models/update_library_masking_format_details.rb', line 58

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'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



129
130
131
132
133
134
135
136
137
138
139
# File 'lib/oci/data_safe/models/update_library_masking_format_details.rb', line 129

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

  self.class == other.class &&
    display_name == other.display_name &&
    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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'lib/oci/data_safe/models/update_library_masking_format_details.rb', line 164

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


144
145
146
# File 'lib/oci/data_safe/models/update_library_masking_format_details.rb', line 144

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



153
154
155
# File 'lib/oci/data_safe/models/update_library_masking_format_details.rb', line 153

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



197
198
199
200
201
202
203
204
205
206
# File 'lib/oci/data_safe/models/update_library_masking_format_details.rb', line 197

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



191
192
193
# File 'lib/oci/data_safe/models/update_library_masking_format_details.rb', line 191

def to_s
  to_hash.to_s
end