Class: OCI::DataSafe::Models::MaskingPolicyHealthReportLogSummary

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

Overview

A log entry related to the pre-masking health check.

Constant Summary collapse

MESSAGE_TYPE_ENUM = 
[
  MESSAGE_TYPE_PASS = 'PASS'.freeze,
  MESSAGE_TYPE_WARNING = 'WARNING'.freeze,
  MESSAGE_TYPE_ERROR = 'ERROR'.freeze,
  MESSAGE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
HEALTH_CHECK_TYPE_ENUM = 
[
  HEALTH_CHECK_TYPE_INVALID_OBJECT_CHECK = 'INVALID_OBJECT_CHECK'.freeze,
  HEALTH_CHECK_TYPE_PRIVILEGE_CHECK = 'PRIVILEGE_CHECK'.freeze,
  HEALTH_CHECK_TYPE_TABLESPACE_CHECK = 'TABLESPACE_CHECK'.freeze,
  HEALTH_CHECK_TYPE_DATABASE_OR_SYSTEM_TRIGGERS_CHECK = 'DATABASE_OR_SYSTEM_TRIGGERS_CHECK'.freeze,
  HEALTH_CHECK_TYPE_UNDO_TABLESPACE_CHECK = 'UNDO_TABLESPACE_CHECK'.freeze,
  HEALTH_CHECK_TYPE_STATE_STATS_CHECK = 'STATE_STATS_CHECK'.freeze,
  HEALTH_CHECK_TYPE_OLS_POLICY_CHECK = 'OLS_POLICY_CHECK'.freeze,
  HEALTH_CHECK_TYPE_VPD_POLICY_CHECK = 'VPD_POLICY_CHECK'.freeze,
  HEALTH_CHECK_TYPE_DV_ENABLE_CHECK = 'DV_ENABLE_CHECK'.freeze,
  HEALTH_CHECK_TYPE_DE_COL_SIZE_CHECK = 'DE_COL_SIZE_CHECK'.freeze,
  HEALTH_CHECK_TYPE_REDACTION_POLICY_CHECK = 'REDACTION_POLICY_CHECK'.freeze,
  HEALTH_CHECK_TYPE_ACTIVE_MASK_JOB_CHECK = 'ACTIVE_MASK_JOB_CHECK'.freeze,
  HEALTH_CHECK_TYPE_TARGET_VALIDATION_CHECK = 'TARGET_VALIDATION_CHECK'.freeze,
  HEALTH_CHECK_TYPE_DETERMINISTIC_ENCRYPTION_FORMAT_CHECK = 'DETERMINISTIC_ENCRYPTION_FORMAT_CHECK'.freeze,
  HEALTH_CHECK_TYPE_COLUMN_EXIST_CHECK = 'COLUMN_EXIST_CHECK'.freeze,
  HEALTH_CHECK_TYPE_TIME_TRAVEL_CHECK = 'TIME_TRAVEL_CHECK'.freeze,
  HEALTH_CHECK_TYPE_SYSTEM_OBJECTS_CHECK = 'SYSTEM_OBJECTS_CHECK'.freeze,
  HEALTH_CHECK_TYPE_INVALID_PACKAGE_CHECK = 'INVALID_PACKAGE_CHECK'.freeze,
  HEALTH_CHECK_TYPE_AUDIT_POLICY_CHECK = 'AUDIT_POLICY_CHECK'.freeze,
  HEALTH_CHECK_TYPE_USER_CREDENTIALS_CHECK = 'USER_CREDENTIALS_CHECK'.freeze,
  HEALTH_CHECK_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MaskingPolicyHealthReportLogSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :message_type (String) —

    The value to assign to the #message_type property

  • :timestamp (DateTime) —

    The value to assign to the #timestamp property

  • :message (String) —

    The value to assign to the #message property

  • :remediation (String) —

    The value to assign to the #remediation property

  • :description (String) —

    The value to assign to the #description property

  • :health_check_type (String) —

    The value to assign to the #health_check_type property



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

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

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

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

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

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

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

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

  self.health_check_type = attributes[:'healthCheckType'] if attributes[:'healthCheckType']

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

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

Instance Attribute Details

#description ⇒ String

[Required] A human-readable description for the log entry.

Returns:

  • (String) 


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

def description
  @description
end

#health_check_type ⇒ String

An enum type entry for each health check in the masking policy. Each enum describes a type of health check. INVALID_OBJECT_CHECK checks if there exist any invalid objects in the masking tables. PRIVILEGE_CHECK checks if the masking user has sufficient privilege to run masking. TABLESPACE_CHECK checks if the user has sufficient default and TEMP tablespace. Also verifies that the specified tablespace by the user is valid, if user has provided one DATABASE_OR_SYSTEM_TRIGGERS_CHECK checks if there exist any database/system triggers available. UNDO_TABLESPACE_CHECK checks if for all the instances of undo tablespace the AUTOEXTEND feature is enabled. If it's not enabled, it further checks if the undo tablespace has any space remaining. STATE_STATS_CHECK checks if all the statistics of the masking table is upto date or not. OLS_POLICY_CHECK , VPD_POLICY_CHECK and REDACTION_POLICY_CHECK checks if the masking tables has Oracle Label Security (OLS) or Virtual Private Database (VPD) or Redaction policies enabled. DV_ENABLE_CHECK checks if database has Database Vault(DV) enabled DE_COL_SIZE_CHECK checks if any masking column with DETERMINISTIC ENCRYPTION as masking format has average column size greater than 27 or not. ACTIVE_MASK_JOB_CHECK checks if there is any active masking job running on the target database. DETERMINISTIC_ENCRYPTION_FORMAT_CHECK checks if any masking column has deterministic encryption masking format. COLUMN_EXIST_CHECK checks if the masking columns are available in the target database. TIME_TRAVEL_CHECK checks if the masking tables have Time Travel enabled. SYSTEM_OBJECTS_CHECK checks if the masking tables have dependent objects present in SYS schema. INVALID_PACKAGE_CHECK checks if any of the required packages are in invalid state. AUDIT_POLICY_CHECK checks if the masking tables have Audit policies enabled. USER_CREDENTIALS_CHECK checks if target database user credentials are required to run masking using the policy

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/data_safe/models/masking_policy_health_report_log_summary.rb', line 85

def health_check_type
  @health_check_type
end

#message ⇒ String

[Required] A human-readable log entry.

Returns:

  • (String) 


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

def message
  @message
end

#message_type ⇒ String

[Required] The log entry type.

Returns:

  • (String) 


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

def message_type
  @message_type
end

#remediation ⇒ String

A human-readable log entry to remedy any error or warnings in the masking policy.

Returns:

  • (String) 


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

def remediation
  @remediation
end

#timestamp ⇒ DateTime

[Required] The date and time the log entry was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


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

def timestamp
  @timestamp
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/data_safe/models/masking_policy_health_report_log_summary.rb', line 88

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'message_type': :'messageType',
    'timestamp': :'timestamp',
    'message': :'message',
    'remediation': :'remediation',
    'description': :'description',
    'health_check_type': :'healthCheckType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/data_safe/models/masking_policy_health_report_log_summary.rb', line 102

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'message_type': :'String',
    'timestamp': :'DateTime',
    'message': :'String',
    'remediation': :'String',
    'description': :'String',
    'health_check_type': :'String'
    # 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



187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/data_safe/models/masking_policy_health_report_log_summary.rb', line 187

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

  self.class == other.class &&
    message_type == other.message_type &&
    timestamp == other.timestamp &&
    message == other.message &&
    remediation == other.remediation &&
    description == other.description &&
    health_check_type == other.health_check_type
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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/data_safe/models/masking_policy_health_report_log_summary.rb', line 222

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


202
203
204
 
# File 'lib/oci/data_safe/models/masking_policy_health_report_log_summary.rb', line 202

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/oci/data_safe/models/masking_policy_health_report_log_summary.rb', line 211

def hash
  [message_type, timestamp, message, remediation, description, health_check_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/data_safe/models/masking_policy_health_report_log_summary.rb', line 255

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



249
250
251
 
# File 'lib/oci/data_safe/models/masking_policy_health_report_log_summary.rb', line 249

def to_s
  to_hash.to_s
end