Class: OCI::Adm::Models::DetectStage

Inherits:
RemediationRunStage show all
Defined in:
lib/oci/adm/models/detect_stage.rb

Overview

A detect stage performs a Vulnerability Audit and determines if the remediation run should proceed to remediation stage.

Constant Summary

Constants inherited from RemediationRunStage

RemediationRunStage::NEXT_STAGE_TYPE_ENUM, RemediationRunStage::PREVIOUS_STAGE_TYPE_ENUM, RemediationRunStage::STATUS_ENUM, RemediationRunStage::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from RemediationRunStage

#next_stage_type, #previous_stage_type, #remediation_run_id, #status, #summary, #time_created, #time_finished, #time_started, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RemediationRunStage

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DetectStage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :status (String) —

    The value to assign to the #status proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_started (DateTime) —

    The value to assign to the #time_started proprety

  • :time_finished (DateTime) —

    The value to assign to the #time_finished proprety

  • :summary (String) —

    The value to assign to the #summary proprety

  • :remediation_run_id (String) —

    The value to assign to the #remediation_run_id proprety

  • :previous_stage_type (String) —

    The value to assign to the #previous_stage_type proprety

  • :next_stage_type (String) —

    The value to assign to the #next_stage_type proprety

  • :audit_id (String) —

    The value to assign to the #audit_id property



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'DETECT'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.audit_id = attributes[:'auditId'] if attributes[:'auditId']

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

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

Instance Attribute Details

#audit_id ⇒ String

The Oracle Cloud identifier (OCID) of the vulnerability audit.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/adm/models/detect_stage.rb', line 15

def audit_id
  @audit_id
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/oci/adm/models/detect_stage.rb', line 18

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'status',
    'time_created': :'timeCreated',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'type': :'type',
    'summary': :'summary',
    'remediation_run_id': :'remediationRunId',
    'previous_stage_type': :'previousStageType',
    'next_stage_type': :'nextStageType',
    'audit_id': :'auditId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/adm/models/detect_stage.rb', line 36

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'String',
    'time_created': :'DateTime',
    'time_started': :'DateTime',
    'time_finished': :'DateTime',
    'type': :'String',
    'summary': :'String',
    'remediation_run_id': :'String',
    'previous_stage_type': :'String',
    'next_stage_type': :'String',
    'audit_id': :'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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/adm/models/detect_stage.rb', line 92

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

  self.class == other.class &&
    status == other.status &&
    time_created == other.time_created &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    type == other.type &&
    summary == other.summary &&
    remediation_run_id == other.remediation_run_id &&
    previous_stage_type == other.previous_stage_type &&
    next_stage_type == other.next_stage_type &&
    audit_id == other.audit_id
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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/adm/models/detect_stage.rb', line 131

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


111
112
113
 
# File 'lib/oci/adm/models/detect_stage.rb', line 111

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



120
121
122
 
# File 'lib/oci/adm/models/detect_stage.rb', line 120

def hash
  [status, time_created, time_started, time_finished, type, summary, remediation_run_id, previous_stage_type, next_stage_type, audit_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/adm/models/detect_stage.rb', line 164

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



158
159
160
 
# File 'lib/oci/adm/models/detect_stage.rb', line 158

def to_s
  to_hash.to_s
end