Class: OCI::Adm::Models::VulnerabilityAuditConfiguration

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/adm/models/vulnerability_audit_configuration.rb

Overview

Configuration for a vulnerability audit. A vulnerable application dependency is ignored if its name does match any of the items in exclusions, or all of the associated Vulnerabilies have a CVSS v2 score below maxPermissibleCvssV2Score and a CVSS v3 score below maxPermissibleCvssV3Score. type: object

Constant Summary collapse

MAX_PERMISSIBLE_SEVERITY_ENUM = 
[
  MAX_PERMISSIBLE_SEVERITY_UNSET = 'UNSET'.freeze,
  MAX_PERMISSIBLE_SEVERITY_NONE = 'NONE'.freeze,
  MAX_PERMISSIBLE_SEVERITY_LOW = 'LOW'.freeze,
  MAX_PERMISSIBLE_SEVERITY_MEDIUM = 'MEDIUM'.freeze,
  MAX_PERMISSIBLE_SEVERITY_HIGH = 'HIGH'.freeze,
  MAX_PERMISSIBLE_SEVERITY_CRITICAL = 'CRITICAL'.freeze,
  MAX_PERMISSIBLE_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 = {}) ⇒ VulnerabilityAuditConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/adm/models/vulnerability_audit_configuration.rb', line 77

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.max_permissible_cvss_v2_score = attributes[:'maxPermissibleCvssV2Score'] if attributes[:'maxPermissibleCvssV2Score']
  self.max_permissible_cvss_v2_score = 0.0 if max_permissible_cvss_v2_score.nil? && !attributes.key?(:'maxPermissibleCvssV2Score') # rubocop:disable Style/StringLiterals

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

  self.max_permissible_cvss_v2_score = attributes[:'max_permissible_cvss_v2_score'] if attributes[:'max_permissible_cvss_v2_score']
  self.max_permissible_cvss_v2_score = 0.0 if max_permissible_cvss_v2_score.nil? && !attributes.key?(:'maxPermissibleCvssV2Score') && !attributes.key?(:'max_permissible_cvss_v2_score') # rubocop:disable Style/StringLiterals

  self.max_permissible_cvss_v3_score = attributes[:'maxPermissibleCvssV3Score'] if attributes[:'maxPermissibleCvssV3Score']
  self.max_permissible_cvss_v3_score = 0.0 if max_permissible_cvss_v3_score.nil? && !attributes.key?(:'maxPermissibleCvssV3Score') # rubocop:disable Style/StringLiterals

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

  self.max_permissible_cvss_v3_score = attributes[:'max_permissible_cvss_v3_score'] if attributes[:'max_permissible_cvss_v3_score']
  self.max_permissible_cvss_v3_score = 0.0 if max_permissible_cvss_v3_score.nil? && !attributes.key?(:'maxPermissibleCvssV3Score') && !attributes.key?(:'max_permissible_cvss_v3_score') # rubocop:disable Style/StringLiterals

  self.max_permissible_severity = attributes[:'maxPermissibleSeverity'] if attributes[:'maxPermissibleSeverity']

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

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

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

Instance Attribute Details

#exclusions ⇒ Array<String>

A vulnerable application dependency is ignored if its name matches any of the items in exclusions. An asterisk (*) in the dependency pattern acts as a wildcard and matches zero or more characters.

Returns:

  • (Array<String>) 


41
42
43
 
# File 'lib/oci/adm/models/vulnerability_audit_configuration.rb', line 41

def exclusions
  @exclusions
end

#max_permissible_cvss_v2_score ⇒ Float

A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.

Returns:

  • (Float) 


27
28
29
 
# File 'lib/oci/adm/models/vulnerability_audit_configuration.rb', line 27

def max_permissible_cvss_v2_score
  @max_permissible_cvss_v2_score
end

#max_permissible_cvss_v3_score ⇒ Float

A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.

Returns:

  • (Float) 


31
32
33
 
# File 'lib/oci/adm/models/vulnerability_audit_configuration.rb', line 31

def max_permissible_cvss_v3_score
  @max_permissible_cvss_v3_score
end

#max_permissible_severity ⇒ String

A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleSeverity.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/adm/models/vulnerability_audit_configuration.rb', line 35

def max_permissible_severity
  @max_permissible_severity
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/adm/models/vulnerability_audit_configuration.rb', line 44

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'max_permissible_cvss_v2_score': :'maxPermissibleCvssV2Score',
    'max_permissible_cvss_v3_score': :'maxPermissibleCvssV3Score',
    'max_permissible_severity': :'maxPermissibleSeverity',
    'exclusions': :'exclusions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/adm/models/vulnerability_audit_configuration.rb', line 56

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'max_permissible_cvss_v2_score': :'Float',
    'max_permissible_cvss_v3_score': :'Float',
    'max_permissible_severity': :'String',
    'exclusions': :'Array<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



128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/adm/models/vulnerability_audit_configuration.rb', line 128

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

  self.class == other.class &&
    max_permissible_cvss_v2_score == other.max_permissible_cvss_v2_score &&
    max_permissible_cvss_v3_score == other.max_permissible_cvss_v3_score &&
    max_permissible_severity == other.max_permissible_severity &&
    exclusions == other.exclusions
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



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/adm/models/vulnerability_audit_configuration.rb', line 161

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


141
142
143
 
# File 'lib/oci/adm/models/vulnerability_audit_configuration.rb', line 141

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



150
151
152
 
# File 'lib/oci/adm/models/vulnerability_audit_configuration.rb', line 150

def hash
  [max_permissible_cvss_v2_score, max_permissible_cvss_v3_score, max_permissible_severity, exclusions].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/adm/models/vulnerability_audit_configuration.rb', line 194

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



188
189
190
 
# File 'lib/oci/adm/models/vulnerability_audit_configuration.rb', line 188

def to_s
  to_hash.to_s
end