Class: OCI::DataSafe::Models::MaskingReport

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

Overview

A masking report contains information about a completed masking request. It includes details such as the target database masked, masking policy used, masking start and finish time, total number of schemas, tables, columns and values masked, masked columns, and the masking formats used.

Constant Summary collapse

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_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MASKING_STATUS_ENUM = 
[
  MASKING_STATUS_FAILED = 'FAILED'.freeze,
  MASKING_STATUS_SUCCESS = 'SUCCESS'.freeze,
  MASKING_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MaskingReport

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 213

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

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

  self.masking_work_request_id = attributes[:'masking_work_request_id'] if attributes[:'masking_work_request_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.target_id = attributes[:'targetId'] if attributes[:'targetId']

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

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

  self.total_masked_sensitive_types = attributes[:'totalMaskedSensitiveTypes'] if attributes[:'totalMaskedSensitiveTypes']

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

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

  self.total_masked_schemas = attributes[:'totalMaskedSchemas'] if attributes[:'totalMaskedSchemas']

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

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

  self.total_masked_objects = attributes[:'totalMaskedObjects'] if attributes[:'totalMaskedObjects']

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

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

  self.total_masked_columns = attributes[:'totalMaskedColumns'] if attributes[:'totalMaskedColumns']

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

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

  self.total_masked_values = attributes[:'totalMaskedValues'] if attributes[:'totalMaskedValues']

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

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

  self.time_masking_started = attributes[:'timeMaskingStarted'] if attributes[:'timeMaskingStarted']

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

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

  self.time_masking_finished = attributes[:'timeMaskingFinished'] if attributes[:'timeMaskingFinished']

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

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

  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.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.is_drop_temp_tables_enabled = attributes[:'isDropTempTablesEnabled'] unless attributes[:'isDropTempTablesEnabled'].nil?

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

  self.is_drop_temp_tables_enabled = attributes[:'is_drop_temp_tables_enabled'] unless attributes[:'is_drop_temp_tables_enabled'].nil?

  self.is_redo_logging_enabled = attributes[:'isRedoLoggingEnabled'] unless attributes[:'isRedoLoggingEnabled'].nil?

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

  self.is_redo_logging_enabled = attributes[:'is_redo_logging_enabled'] unless attributes[:'is_redo_logging_enabled'].nil?

  self.is_refresh_stats_enabled = attributes[:'isRefreshStatsEnabled'] unless attributes[:'isRefreshStatsEnabled'].nil?

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

  self.is_refresh_stats_enabled = attributes[:'is_refresh_stats_enabled'] unless attributes[:'is_refresh_stats_enabled'].nil?

  self.parallel_degree = attributes[:'parallelDegree'] if attributes[:'parallelDegree']

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

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

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

  self.masking_status = attributes[:'maskingStatus'] if attributes[:'maskingStatus']

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

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

  self.total_pre_masking_script_errors = attributes[:'totalPreMaskingScriptErrors'] if attributes[:'totalPreMaskingScriptErrors']

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

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

  self.total_post_masking_script_errors = attributes[:'totalPostMaskingScriptErrors'] if attributes[:'totalPostMaskingScriptErrors']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the masking report.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 37

def compartment_id
  @compartment_id
end

#id ⇒ String

[Required] The OCID of the masking report.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 33

def id
  @id
end

#is_drop_temp_tables_enabled ⇒ BOOLEAN

Indicates if the temporary tables created during the masking operation were dropped after masking.

Returns:

  • (BOOLEAN) 


91
92
93
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 91

def is_drop_temp_tables_enabled
  @is_drop_temp_tables_enabled
end

#is_redo_logging_enabled ⇒ BOOLEAN

Indicates if redo logging was enabled during the masking operation.

Returns:

  • (BOOLEAN) 


96
97
98
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 96

def is_redo_logging_enabled
  @is_redo_logging_enabled
end

#is_refresh_stats_enabled ⇒ BOOLEAN

Indicates if statistics gathering was enabled during the masking operation.

Returns:

  • (BOOLEAN) 


101
102
103
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 101

def is_refresh_stats_enabled
  @is_refresh_stats_enabled
end

#lifecycle_state ⇒ String

[Required] The current state of the masking report.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 81

def lifecycle_state
  @lifecycle_state
end

#masking_policy_id ⇒ String

[Required] The OCID of the masking policy used.

Returns:

  • (String) 


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

def masking_policy_id
  @masking_policy_id
end

#masking_status ⇒ String

[Required] The status of the masking job.

Returns:

  • (String) 


115
116
117
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 115

def masking_status
  @masking_status
end

#masking_work_request_id ⇒ String

[Required] The OCID of the masking work request that resulted in this masking report.

Returns:

  • (String) 


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

def masking_work_request_id
  @masking_work_request_id
end

#parallel_degree ⇒ String

Indicates if parallel execution was enabled during the masking operation.

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 106

def parallel_degree
  @parallel_degree
end

#recompile ⇒ String

Indicates how invalid objects were recompiled post the masking operation.

Returns:

  • (String) 


111
112
113
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 111

def recompile
  @recompile
end

#target_id ⇒ String

[Required] The OCID of the target database masked.

Returns:

  • (String) 


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

def target_id
  @target_id
end

#time_created ⇒ DateTime

The date and time the masking report was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


86
87
88
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 86

def time_created
  @time_created
end

#time_masking_finished ⇒ DateTime

[Required] The date and time data masking finished, in the format defined by RFC3339

Returns:

  • (DateTime) 


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

def time_masking_finished
  @time_masking_finished
end

#time_masking_started ⇒ DateTime

[Required] The date and time data masking started, in the format defined by RFC3339

Returns:

  • (DateTime) 


73
74
75
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 73

def time_masking_started
  @time_masking_started
end

#total_masked_columns ⇒ Integer

[Required] The total number of masked columns.

Returns:

  • (Integer) 


65
66
67
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 65

def total_masked_columns
  @total_masked_columns
end

#total_masked_objects ⇒ Integer

[Required] The total number of unique objects (tables and editioning views) that contain the masked columns.

Returns:

  • (Integer) 


61
62
63
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 61

def total_masked_objects
  @total_masked_objects
end

#total_masked_schemas ⇒ Integer

[Required] The total number of unique schemas that contain the masked columns.

Returns:

  • (Integer) 


57
58
59
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 57

def total_masked_schemas
  @total_masked_schemas
end

#total_masked_sensitive_types ⇒ Integer

[Required] The total number of unique sensitive types associated with the masked columns.

Returns:

  • (Integer) 


53
54
55
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 53

def total_masked_sensitive_types
  @total_masked_sensitive_types
end

#total_masked_values ⇒ Integer

[Required] The total number of masked values.

Returns:

  • (Integer) 


69
70
71
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 69

def total_masked_values
  @total_masked_values
end

#total_post_masking_script_errors ⇒ Integer

The total number of errors in post-masking script.

Returns:

  • (Integer) 


123
124
125
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 123

def total_post_masking_script_errors
  @total_post_masking_script_errors
end

#total_pre_masking_script_errors ⇒ Integer

The total number of errors in pre-masking script.

Returns:

  • (Integer) 


119
120
121
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 119

def total_pre_masking_script_errors
  @total_pre_masking_script_errors
end

Class Method Details

.attribute_map ⇒ Object

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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 126

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'masking_work_request_id': :'maskingWorkRequestId',
    'masking_policy_id': :'maskingPolicyId',
    'target_id': :'targetId',
    'total_masked_sensitive_types': :'totalMaskedSensitiveTypes',
    'total_masked_schemas': :'totalMaskedSchemas',
    'total_masked_objects': :'totalMaskedObjects',
    'total_masked_columns': :'totalMaskedColumns',
    'total_masked_values': :'totalMaskedValues',
    'time_masking_started': :'timeMaskingStarted',
    'time_masking_finished': :'timeMaskingFinished',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'is_drop_temp_tables_enabled': :'isDropTempTablesEnabled',
    'is_redo_logging_enabled': :'isRedoLoggingEnabled',
    'is_refresh_stats_enabled': :'isRefreshStatsEnabled',
    'parallel_degree': :'parallelDegree',
    'recompile': :'recompile',
    'masking_status': :'maskingStatus',
    'total_pre_masking_script_errors': :'totalPreMaskingScriptErrors',
    'total_post_masking_script_errors': :'totalPostMaskingScriptErrors'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 156

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'masking_work_request_id': :'String',
    'masking_policy_id': :'String',
    'target_id': :'String',
    'total_masked_sensitive_types': :'Integer',
    'total_masked_schemas': :'Integer',
    'total_masked_objects': :'Integer',
    'total_masked_columns': :'Integer',
    'total_masked_values': :'Integer',
    'time_masking_started': :'DateTime',
    'time_masking_finished': :'DateTime',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'is_drop_temp_tables_enabled': :'BOOLEAN',
    'is_redo_logging_enabled': :'BOOLEAN',
    'is_refresh_stats_enabled': :'BOOLEAN',
    'parallel_degree': :'String',
    'recompile': :'String',
    'masking_status': :'String',
    'total_pre_masking_script_errors': :'Integer',
    'total_post_masking_script_errors': :'Integer'
    # 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



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 377

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    masking_work_request_id == other.masking_work_request_id &&
    masking_policy_id == other.masking_policy_id &&
    target_id == other.target_id &&
    total_masked_sensitive_types == other.total_masked_sensitive_types &&
    total_masked_schemas == other.total_masked_schemas &&
    total_masked_objects == other.total_masked_objects &&
    total_masked_columns == other.total_masked_columns &&
    total_masked_values == other.total_masked_values &&
    time_masking_started == other.time_masking_started &&
    time_masking_finished == other.time_masking_finished &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    is_drop_temp_tables_enabled == other.is_drop_temp_tables_enabled &&
    is_redo_logging_enabled == other.is_redo_logging_enabled &&
    is_refresh_stats_enabled == other.is_refresh_stats_enabled &&
    parallel_degree == other.parallel_degree &&
    recompile == other.recompile &&
    masking_status == other.masking_status &&
    total_pre_masking_script_errors == other.total_pre_masking_script_errors &&
    total_post_masking_script_errors == other.total_post_masking_script_errors
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



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 428

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


408
409
410
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 408

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



417
418
419
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 417

def hash
  [id, compartment_id, masking_work_request_id, masking_policy_id, target_id, total_masked_sensitive_types, total_masked_schemas, total_masked_objects, total_masked_columns, total_masked_values, time_masking_started, time_masking_finished, lifecycle_state, time_created, is_drop_temp_tables_enabled, is_redo_logging_enabled, is_refresh_stats_enabled, parallel_degree, recompile, masking_status, total_pre_masking_script_errors, total_post_masking_script_errors].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



461
462
463
464
465
466
467
468
469
470
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 461

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



455
456
457
 
# File 'lib/oci/data_safe/models/masking_report.rb', line 455

def to_s
  to_hash.to_s
end