Class: OCI::DataSafe::Models::CheckSummary

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

Overview

The summary of the security rule to be evaluated by security assessment to create finding.

Constant Summary collapse

SUGGESTED_SEVERITY_ENUM = 
[
  SUGGESTED_SEVERITY_HIGH = 'HIGH'.freeze,
  SUGGESTED_SEVERITY_MEDIUM = 'MEDIUM'.freeze,
  SUGGESTED_SEVERITY_LOW = 'LOW'.freeze,
  SUGGESTED_SEVERITY_EVALUATE = 'EVALUATE'.freeze,
  SUGGESTED_SEVERITY_ADVISORY = 'ADVISORY'.freeze,
  SUGGESTED_SEVERITY_PASS = 'PASS'.freeze,
  SUGGESTED_SEVERITY_DEFERRED = 'DEFERRED'.freeze,
  SUGGESTED_SEVERITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CheckSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String) —

    The value to assign to the #key property

  • :title (String) —

    The value to assign to the #title property

  • :remarks (String) —

    The value to assign to the #remarks property

  • :references (OCI::DataSafe::Models::References) —

    The value to assign to the #references property

  • :category (String) —

    The value to assign to the #category property

  • :oneline (String) —

    The value to assign to the #oneline property

  • :suggested_severity (String) —

    The value to assign to the #suggested_severity property



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/data_safe/models/check_summary.rb', line 94

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

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

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

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

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

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

  self.suggested_severity = attributes[:'suggestedSeverity'] if attributes[:'suggestedSeverity']

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

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

Instance Attribute Details

#category ⇒ String

The category to which the check belongs to.

Returns:

  • (String) 


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

def category
  @category
end

#key ⇒ String

[Required] A unique identifier for the check.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/data_safe/models/check_summary.rb', line 25

def key
  @key
end

#oneline ⇒ String

Provides a recommended approach to take to remediate the check reported.

Returns:

  • (String) 


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

def oneline
  @oneline
end

#references ⇒ OCI::DataSafe::Models::References

Provides information on whether the check is related to a CIS Oracle Database Benchmark recommendation, STIG rule, GDPR Article/Recital or related to the Oracle Recommended Practice.

Returns:



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

def references
  @references
end

#remarks ⇒ String

The explanation of the issue in this check. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation.

Returns:

  • (String) 


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

def remarks
  @remarks
end

#suggested_severity ⇒ String

The severity of the check as suggested by Data Safe security assessment. This will be the default severity in the template baseline security assessment.

Returns:

  • (String) 


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

def suggested_severity
  @suggested_severity
end

#title ⇒ String

[Required] The short title for the check.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/data_safe/models/check_summary.rb', line 29

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/data_safe/models/check_summary.rb', line 52

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'title': :'title',
    'remarks': :'remarks',
    'references': :'references',
    'category': :'category',
    'oneline': :'oneline',
    'suggested_severity': :'suggestedSeverity'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/data_safe/models/check_summary.rb', line 67

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'title': :'String',
    'remarks': :'String',
    'references': :'OCI::DataSafe::Models::References',
    'category': :'String',
    'oneline': :'String',
    'suggested_severity': :'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



139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/data_safe/models/check_summary.rb', line 139

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

  self.class == other.class &&
    key == other.key &&
    title == other.title &&
    remarks == other.remarks &&
    references == other.references &&
    category == other.category &&
    oneline == other.oneline &&
    suggested_severity == other.suggested_severity
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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/data_safe/models/check_summary.rb', line 175

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


155
156
157
 
# File 'lib/oci/data_safe/models/check_summary.rb', line 155

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



164
165
166
 
# File 'lib/oci/data_safe/models/check_summary.rb', line 164

def hash
  [key, title, remarks, references, category, oneline, suggested_severity].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
 
# File 'lib/oci/data_safe/models/check_summary.rb', line 208

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



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

def to_s
  to_hash.to_s
end