Class: OCI::Adm::Models::ApplicationDependencyVulnerabilitySummary

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

Overview

An application dependency Vulnerability represents a single dependency in the application. An application dependency Vulnerability can be associated with eventual Vulnerabilities. Each application dependency is uniquely defined by a nodeId and lists eventual dependencies on which it depends.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApplicationDependencyVulnerabilitySummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
125
126
127
128
129
 
# File 'lib/oci/adm/models/application_dependency_vulnerability_summary.rb', line 98

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

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

  self.node_id = attributes[:'nodeId'] if attributes[:'nodeId']

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

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

  self.application_dependency_node_ids = attributes[:'applicationDependencyNodeIds'] if attributes[:'applicationDependencyNodeIds']

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

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

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

  self.is_found_in_knowledge_base = attributes[:'isFoundInKnowledgeBase'] unless attributes[:'isFoundInKnowledgeBase'].nil?

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

  self.is_found_in_knowledge_base = attributes[:'is_found_in_knowledge_base'] unless attributes[:'is_found_in_knowledge_base'].nil?

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

Instance Attribute Details

#application_dependency_node_ids ⇒ Array<String>

[Required] List of application dependencies on which this application dependency depends, each identified by its nodeId.

Returns:

  • (Array<String>) 


30
31
32
 
# File 'lib/oci/adm/models/application_dependency_vulnerability_summary.rb', line 30

def application_dependency_node_ids
  @application_dependency_node_ids
end

#gav ⇒ String

[Required] Group Artifact Version (GAV) identifier (Group:Artifact:Version). Example: org.graalvm.nativeimage:svm:21.1.0. "N/A" for non-maven artifacts.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/adm/models/application_dependency_vulnerability_summary.rb', line 18

def gav
  @gav
end

#is_found_in_knowledge_base ⇒ BOOLEAN

[Required] Indicates if the artifact is found in the knowledge base, this field is deprecated and will be removed in the future.

Returns:

  • (BOOLEAN) 


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

def is_found_in_knowledge_base
  @is_found_in_knowledge_base
end

#node_id ⇒ String

[Required] Unique identifier of an application dependency, for example nodeId1.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/adm/models/application_dependency_vulnerability_summary.rb', line 26

def node_id
  @node_id
end

#purl ⇒ String

Package URL identifier, e.g. pkg:maven/org.graalvm.nativeimage/svm@21.1.0

Returns:

  • (String) 


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

def purl
  @purl
end

#vulnerabilities ⇒ Array<OCI::Adm::Models::Vulnerability>

[Required] List of vulnerabilities for the application dependency.

Returns:



34
35
36
 
# File 'lib/oci/adm/models/application_dependency_vulnerability_summary.rb', line 34

def vulnerabilities
  @vulnerabilities
end

#warnings ⇒ Array<String>

Potential issues in the artifact identifiers (purls) provided by the user, that the user is alerted about. ADM supports the following warnings: - MISSING_VERSION: Missing version - INCORRECT_FORMAT_VERSION: Version can not be parsed according to the ecosystem - UNKNOWN_ECOSYSTEM: The purl's ecosystem is unknown to ADM - INCORRECT_FORMAT_EPOCH: Epoch qualifier can not be parsed according to the ecosystem - MISSING_DISTRO: The distro qualifier is required for the ecosystem, but was not provided in the purl - UNKNOWN_DISTRO: ADM does not have data for the provided distro value for the given ecosystem - MISSING_ARCH: The arch qualifier is required for the ecosystem and distro, but was not provided in the purl - UNKNOWN_ARCH: ADM does not have data for the provided arch value for the given ecosystem and distro - EPOCH_VALUE_MISMATCH: Epoch value in qualifier is not the same as the epoch value in version - INVALID_PURL: The provided PURL could not be parsed

Returns:

  • (Array<String>) 


53
54
55
 
# File 'lib/oci/adm/models/application_dependency_vulnerability_summary.rb', line 53

def warnings
  @warnings
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'gav': :'gav',
    'purl': :'purl',
    'node_id': :'nodeId',
    'application_dependency_node_ids': :'applicationDependencyNodeIds',
    'vulnerabilities': :'vulnerabilities',
    'is_found_in_knowledge_base': :'isFoundInKnowledgeBase',
    'warnings': :'warnings'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/adm/models/application_dependency_vulnerability_summary.rb', line 71

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'gav': :'String',
    'purl': :'String',
    'node_id': :'String',
    'application_dependency_node_ids': :'Array<String>',
    'vulnerabilities': :'Array<OCI::Adm::Models::Vulnerability>',
    'is_found_in_knowledge_base': :'BOOLEAN',
    'warnings': :'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



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/adm/models/application_dependency_vulnerability_summary.rb', line 138

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

  self.class == other.class &&
    gav == other.gav &&
    purl == other.purl &&
    node_id == other.node_id &&
    application_dependency_node_ids == other.application_dependency_node_ids &&
    vulnerabilities == other.vulnerabilities &&
    is_found_in_knowledge_base == other.is_found_in_knowledge_base &&
    warnings == other.warnings
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



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

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


154
155
156
 
# File 'lib/oci/adm/models/application_dependency_vulnerability_summary.rb', line 154

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/oci/adm/models/application_dependency_vulnerability_summary.rb', line 163

def hash
  [gav, purl, node_id, application_dependency_node_ids, vulnerabilities, is_found_in_knowledge_base, warnings].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/adm/models/application_dependency_vulnerability_summary.rb', line 207

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



201
202
203
 
# File 'lib/oci/adm/models/application_dependency_vulnerability_summary.rb', line 201

def to_s
  to_hash.to_s
end