Class: OCI::Adm::Models::DetectConfiguration

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

Overview

A configuration to define the constraints when detecting vulnerable dependencies.

Constant Summary collapse

UPGRADE_POLICY_ENUM = 
[
  UPGRADE_POLICY_NEAREST = 'NEAREST'.freeze,
  UPGRADE_POLICY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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 = {}) ⇒ DetectConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 89

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

  self.upgrade_policy = attributes[:'upgradePolicy'] if attributes[:'upgradePolicy']

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

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

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

Instance Attribute Details

#exclusions ⇒ Array<String>

The list of dependencies to be ignored by the recommendation algorithm. The dependency pattern is matched against the 'group:artifact:version' or the purl of a dependency. An asterisk (*) at the end in the dependency pattern acts as a wildcard and matches zero or more characters.

Returns:

  • (Array<String>) 


32
33
34
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 32

def exclusions
  @exclusions
end

#max_permissible_cvss_v2_score ⇒ Float

The maximum Common Vulnerability Scoring System Version 2 (CVSS V2) score. An artifact with a CVSS V2 score below this value is not considered for patching.

Returns:

  • (Float) 


42
43
44
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 42

def max_permissible_cvss_v2_score
  @max_permissible_cvss_v2_score
end

#max_permissible_cvss_v3_score ⇒ Float

The maximum Common Vulnerability Scoring System Version 3 (CVSS V3) score. An artifact with a CVSS V3 score below this value is not considered for patching.

Returns:

  • (Float) 


46
47
48
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 46

def max_permissible_cvss_v3_score
  @max_permissible_cvss_v3_score
end

#max_permissible_severity ⇒ String

The maximum ADM Severity. An artifact with an ADM Severity below this value is not considered for patching.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 50

def max_permissible_severity
  @max_permissible_severity
end

#upgrade_policy ⇒ String

The upgrade policy for recommendations. The Nearest upgrade policy upgrades a dependency to the oldest version that meets both of the following criteria: it is newer than the current version and it is not affected by a vulnerability.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 38

def upgrade_policy
  @upgrade_policy
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 53

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

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 66

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



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 159

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

  self.class == other.class &&
    exclusions == other.exclusions &&
    upgrade_policy == other.upgrade_policy &&
    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
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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 193

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


173
174
175
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 173

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



182
183
184
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 182

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 226

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



220
221
222
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 220

def to_s
  to_hash.to_s
end