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

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):



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 72

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

  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_v3_score = attributes[:'maxPermissibleCvssV3Score'] if attributes[:'maxPermissibleCvssV3Score']

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


22
23
24
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 22

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) 


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

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) 


36
37
38
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 36

def max_permissible_cvss_v3_score
  @max_permissible_cvss_v3_score
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) 


28
29
30
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 28

def upgrade_policy
  @upgrade_policy
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 39

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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'
    # 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



119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 119

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
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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 152

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


132
133
134
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 132

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 185

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



179
180
181
 
# File 'lib/oci/adm/models/detect_configuration.rb', line 179

def to_s
  to_hash.to_s
end