class OCI::VulnerabilityScanning::Models::ContainerScanResultSummary

A summary of a result for a container scan

Constants

HIGHEST_PROBLEM_SEVERITY_ENUM

Attributes

compartment_id[RW]

[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 @return [String]

highest_problem_severity[R]

[Required] Highest problem severity in this report @return [String]

id[RW]

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

image[RW]

[Required] Image name @return [String]

problem_count[RW]

[Required] Total number of problems found in this scan @return [Integer]

repository[RW]

[Required] Repository in which the container image scanned is located @return [String]

time_finished[RW]

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

time_started[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/vulnerability_scanning/models/container_scan_result_summary.rb, line 53
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'repository': :'repository',
    'image': :'image',
    'compartment_id': :'compartmentId',
    'highest_problem_severity': :'highestProblemSeverity',
    'problem_count': :'problemCount',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :repository The value to assign to the {#repository} property @option attributes [String] :image The value to assign to the {#image} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :highest_problem_severity The value to assign to the {#highest_problem_severity} property @option attributes [Integer] :problem_count The value to assign to the {#problem_count} property @option attributes [DateTime] :time_started The value to assign to the {#time_started} property @option attributes [DateTime] :time_finished The value to assign to the {#time_finished} property

# File lib/oci/vulnerability_scanning/models/container_scan_result_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.id = attributes[:'id'] if attributes[:'id']

  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.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']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/vulnerability_scanning/models/container_scan_result_summary.rb, line 69
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'repository': :'String',
    'image': :'String',
    'compartment_id': :'String',
    'highest_problem_severity': :'String',
    'problem_count': :'Integer',
    'time_started': :'DateTime',
    'time_finished': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/vulnerability_scanning/models/container_scan_result_summary.rb, line 161
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    repository == other.repository &&
    image == other.image &&
    compartment_id == other.compartment_id &&
    highest_problem_severity == other.highest_problem_severity &&
    problem_count == other.problem_count &&
    time_started == other.time_started &&
    time_finished == other.time_finished
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/vulnerability_scanning/models/container_scan_result_summary.rb, line 198
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/vulnerability_scanning/models/container_scan_result_summary.rb, line 178
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/vulnerability_scanning/models/container_scan_result_summary.rb, line 187
def hash
  [id, repository, image, compartment_id, highest_problem_severity, problem_count, time_started, time_finished].hash
end
highest_problem_severity=(highest_problem_severity) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] highest_problem_severity Object to be assigned

# File lib/oci/vulnerability_scanning/models/container_scan_result_summary.rb, line 145
def highest_problem_severity=(highest_problem_severity)
  # rubocop:disable Style/ConditionalAssignment
  if highest_problem_severity && !HIGHEST_PROBLEM_SEVERITY_ENUM.include?(highest_problem_severity)
    OCI.logger.debug("Unknown value for 'highest_problem_severity' [" + highest_problem_severity + "]. Mapping to 'HIGHEST_PROBLEM_SEVERITY_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @highest_problem_severity = HIGHEST_PROBLEM_SEVERITY_UNKNOWN_ENUM_VALUE
  else
    @highest_problem_severity = highest_problem_severity
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/vulnerability_scanning/models/container_scan_result_summary.rb, line 231
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/vulnerability_scanning/models/container_scan_result_summary.rb, line 225
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/vulnerability_scanning/models/container_scan_result_summary.rb, line 248
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end