Class: OCI::VulnerabilityScanning::Models::ContainerScanResult

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vulnerability_scanning/models/container_scan_result.rb

Overview

A scan result for a container scan

Constant Summary collapse

HIGHEST_PROBLEM_SEVERITY_ENUM = 
[
  HIGHEST_PROBLEM_SEVERITY_NONE = 'NONE'.freeze,
  HIGHEST_PROBLEM_SEVERITY_LOW = 'LOW'.freeze,
  HIGHEST_PROBLEM_SEVERITY_MEDIUM = 'MEDIUM'.freeze,
  HIGHEST_PROBLEM_SEVERITY_HIGH = 'HIGH'.freeze,
  HIGHEST_PROBLEM_SEVERITY_CRITICAL = 'CRITICAL'.freeze,
  HIGHEST_PROBLEM_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 = {}) ⇒ ContainerScanResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 126

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

  self.registry_url = attributes[:'registryUrl'] if attributes[:'registryUrl']

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

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.target_compartment_id = attributes[:'targetCompartmentId'] if attributes[:'targetCompartmentId']

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

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

  self.container_scan_target_id = attributes[:'containerScanTargetId'] if attributes[:'containerScanTargetId']

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

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

  self.highest_problem_severity = attributes[:'highestProblemSeverity'] if attributes[:'highestProblemSeverity']

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

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

  self.problem_count = attributes[:'problemCount'] if attributes[:'problemCount']

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

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

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

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

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

  self.time_finished = attributes[:'timeFinished'] if attributes[:'timeFinished']

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

**[Required]** The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container scan result's compartment. This is set to the same as the compartmentId of the container scan target

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 38

def compartment_id
  @compartment_id
end

#container_scan_target_id ⇒ String

The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of container scan target.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 46

def container_scan_target_id
  @container_scan_target_id
end

#highest_problem_severity ⇒ String

**[Required]** Highest problem severity in this report

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 50

def highest_problem_severity
  @highest_problem_severity
end

#id ⇒ String

**[Required]** The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of container scan result. Immutable and generated on creation.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 22

def id
  @id
end

#image ⇒ String

**[Required]** Image name

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 34

def image
  @image
end

#problem_count ⇒ Integer

Total number of problems found in this scan

Returns:

  • (Integer) 


54
55
56
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 54

def problem_count
  @problem_count
end

#problems ⇒ Array<OCI::VulnerabilityScanning::Models::ContainerScanResultProblem>

**[Required]** List of problems found in this scan

Returns:



66
67
68
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 66

def problems
  @problems
end

#registry_url ⇒ String

The URL of the docker registry the repository is located in.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 26

def registry_url
  @registry_url
end

#repository ⇒ String

**[Required]** Repository in which the container image scanned is located

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 30

def repository
  @repository
end

#target_compartment_id ⇒ String

The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to where scan was performed.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 42

def target_compartment_id
  @target_compartment_id
end

#time_finished ⇒ DateTime

**[Required]** Date and time the scan was completed, as described in [RFC 3339](tools.ietf.org/rfc/rfc3339)

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 62

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

**[Required]** Date and time the scan was started, as described in [RFC 3339](tools.ietf.org/rfc/rfc3339)

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 58

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 69

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'registry_url': :'registryUrl',
    'repository': :'repository',
    'image': :'image',
    'compartment_id': :'compartmentId',
    'target_compartment_id': :'targetCompartmentId',
    'container_scan_target_id': :'containerScanTargetId',
    'highest_problem_severity': :'highestProblemSeverity',
    'problem_count': :'problemCount',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'problems': :'problems'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 89

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'registry_url': :'String',
    'repository': :'String',
    'image': :'String',
    'compartment_id': :'String',
    'target_compartment_id': :'String',
    'container_scan_target_id': :'String',
    'highest_problem_severity': :'String',
    'problem_count': :'Integer',
    'time_started': :'DateTime',
    'time_finished': :'DateTime',
    'problems': :'Array<OCI::VulnerabilityScanning::Models::ContainerScanResultProblem>'
    # 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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 209

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

  self.class == other.class &&
    id == other.id &&
    registry_url == other.registry_url &&
    repository == other.repository &&
    image == other.image &&
    compartment_id == other.compartment_id &&
    target_compartment_id == other.target_compartment_id &&
    container_scan_target_id == other.container_scan_target_id &&
    highest_problem_severity == other.highest_problem_severity &&
    problem_count == other.problem_count &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    problems == other.problems
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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 250

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


230
231
232
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 230

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



239
240
241
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 239

def hash
  [id, registry_url, repository, image, compartment_id, target_compartment_id, container_scan_target_id, highest_problem_severity, problem_count, time_started, time_finished, problems].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



283
284
285
286
287
288
289
290
291
292
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 283

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



277
278
279
 
# File 'lib/oci/vulnerability_scanning/models/container_scan_result.rb', line 277

def to_s
  to_hash.to_s
end