Class: OCI::DataSafe::Models::SdmMaskingPolicyDifference

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

Overview

A resource that tracks the differences between sensitive columns in the sensitive data model and masking columns in the masking policy

Constant Summary collapse

DIFFERENCE_TYPE_ENUM = 
[
  DIFFERENCE_TYPE_ALL = 'ALL'.freeze,
  DIFFERENCE_TYPE_NEW = 'NEW'.freeze,
  DIFFERENCE_TYPE_MODIFIED = 'MODIFIED'.freeze,
  DIFFERENCE_TYPE_DELETED = 'DELETED'.freeze,
  DIFFERENCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SdmMaskingPolicyDifference

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :difference_type (String) —

    The value to assign to the #difference_type property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_creation_started (DateTime) —

    The value to assign to the #time_creation_started property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :sensitive_data_model_id (String) —

    The value to assign to the #sensitive_data_model_id property

  • :masking_policy_id (String) —

    The value to assign to the #masking_policy_id property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 150

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

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

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

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

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

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

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

  self.time_creation_started = attributes[:'timeCreationStarted'] if attributes[:'timeCreationStarted']

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

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

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

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

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

  self.masking_policy_id = attributes[:'maskingPolicyId'] if attributes[:'maskingPolicyId']

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

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

  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']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the Sensitive data model and masking policy difference resource.

Returns:

  • (String) 


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

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


84
85
86
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 84

def defined_tags
  @defined_tags
end

#difference_type ⇒ String

[Required] The type of the SDM masking policy difference. It defines the difference scope. NEW identifies new sensitive columns in the sensitive data model that are not in the masking policy. DELETED identifies columns that are present in the masking policy but have been deleted from the sensitive data model. MODIFIED identifies columns that are present in the sensitive data model as well as the masking policy but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 45

def difference_type
  @difference_type
end

#display_name ⇒ String

[Required] The display name of the SDM masking policy difference.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 49

def display_name
  @display_name
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>) 


77
78
79
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 77

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Sensitive data model and masking policy difference resource.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the SDM masking policy difference.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 62

def lifecycle_state
  @lifecycle_state
end

#masking_policy_id ⇒ String

[Required] The OCID of the masking policy associated with the SDM masking policy difference.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 70

def masking_policy_id
  @masking_policy_id
end

#sensitive_data_model_id ⇒ String

[Required] The OCID of the sensitive data model associated with the SDM masking policy difference.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 66

def sensitive_data_model_id
  @sensitive_data_model_id
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


90
91
92
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 90

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the SDM masking policy difference was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


54
55
56
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 54

def time_created
  @time_created
end

#time_creation_started ⇒ DateTime

[Required] The date and time the SDM masking policy difference creation started, in the format defined by RFC3339.

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 58

def time_creation_started
  @time_creation_started
end

Class Method Details

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 93

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'difference_type': :'differenceType',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'time_creation_started': :'timeCreationStarted',
    'lifecycle_state': :'lifecycleState',
    'sensitive_data_model_id': :'sensitiveDataModelId',
    'masking_policy_id': :'maskingPolicyId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 113

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'difference_type': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'time_creation_started': :'DateTime',
    'lifecycle_state': :'String',
    'sensitive_data_model_id': :'String',
    'masking_policy_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 258

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    difference_type == other.difference_type &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    time_creation_started == other.time_creation_started &&
    lifecycle_state == other.lifecycle_state &&
    sensitive_data_model_id == other.sensitive_data_model_id &&
    masking_policy_id == other.masking_policy_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 299

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


279
280
281
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 279

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



288
289
290
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 288

def hash
  [id, compartment_id, difference_type, display_name, time_created, time_creation_started, lifecycle_state, sensitive_data_model_id, masking_policy_id, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



332
333
334
335
336
337
338
339
340
341
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 332

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



326
327
328
 
# File 'lib/oci/data_safe/models/sdm_masking_policy_difference.rb', line 326

def to_s
  to_hash.to_s
end