Class: OCI::CloudGuard::Models::CreateDataMaskRuleDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_guard/models/create_data_mask_rule_details.rb

Overview

Parameters to us to create a new data mask rule.

Constant Summary collapse

DATA_MASK_CATEGORIES_ENUM = 
[
  DATA_MASK_CATEGORIES_ACTOR = 'ACTOR'.freeze,
  DATA_MASK_CATEGORIES_PII = 'PII'.freeze,
  DATA_MASK_CATEGORIES_PHI = 'PHI'.freeze,
  DATA_MASK_CATEGORIES_FINANCIAL = 'FINANCIAL'.freeze,
  DATA_MASK_CATEGORIES_LOCATION = 'LOCATION'.freeze,
  DATA_MASK_CATEGORIES_CUSTOM = 'CUSTOM'.freeze
].freeze
DATA_MASK_RULE_STATUS_ENUM = 
[
  DATA_MASK_RULE_STATUS_ENABLED = 'ENABLED'.freeze,
  DATA_MASK_RULE_STATUS_DISABLED = 'DISABLED'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDataMaskRuleDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 137

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

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

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

  self.target_selected = attributes[:'targetSelected'] if attributes[:'targetSelected']

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

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

  self.data_mask_categories = attributes[:'dataMaskCategories'] if attributes[:'dataMaskCategories']

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

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

  self.data_mask_rule_status = attributes[:'dataMaskRuleStatus'] if attributes[:'dataMaskRuleStatus']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  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] Compartment OCID where the resource is created

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 44

def compartment_id
  @compartment_id
end

#data_mask_categories ⇒ Array<String>

[Required] Data mask rule categories

Returns:

  • (Array<String>) 


61
62
63
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 61

def data_mask_categories
  @data_mask_categories
end

#data_mask_rule_status ⇒ String

The current status of the data mask rule

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 65

def data_mask_rule_status
  @data_mask_rule_status
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


83
84
85
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 83

def defined_tags
  @defined_tags
end

#description ⇒ String

The data mask rule description Avoid entering confidential information.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 49

def description
  @description
end

#display_name ⇒ String

[Required] Data mask rule display name

Avoid entering confidential information.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 40

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Avoid entering confidential information.

Returns:

  • (Hash<String, String>) 


77
78
79
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 77

def freeform_tags
  @freeform_tags
end

#iam_group_id ⇒ String

[Required] IAM group ID associated with the data mask rule

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 53

def iam_group_id
  @iam_group_id
end

#lifecycle_state ⇒ String

The current lifecycle state of the data mask rule

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 69

def lifecycle_state
  @lifecycle_state
end

#target_selected ⇒ OCI::CloudGuard::Models::TargetSelected

This attribute is required.

Returns:



57
58
59
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 57

def target_selected
  @target_selected
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 86

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'description': :'description',
    'iam_group_id': :'iamGroupId',
    'target_selected': :'targetSelected',
    'data_mask_categories': :'dataMaskCategories',
    'data_mask_rule_status': :'dataMaskRuleStatus',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 104

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'description': :'String',
    'iam_group_id': :'String',
    'target_selected': :'OCI::CloudGuard::Models::TargetSelected',
    'data_mask_categories': :'Array<String>',
    'data_mask_rule_status': :'String',
    'lifecycle_state': :'String',
    '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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 238

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    iam_group_id == other.iam_group_id &&
    target_selected == other.target_selected &&
    data_mask_categories == other.data_mask_categories &&
    data_mask_rule_status == other.data_mask_rule_status &&
    lifecycle_state == other.lifecycle_state &&
    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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 277

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


257
258
259
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 257

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 266

def hash
  [display_name, compartment_id, description, iam_group_id, target_selected, data_mask_categories, data_mask_rule_status, lifecycle_state, 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



310
311
312
313
314
315
316
317
318
319
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 310

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



304
305
306
 
# File 'lib/oci/cloud_guard/models/create_data_mask_rule_details.rb', line 304

def to_s
  to_hash.to_s
end