Class: OCI::Adm::Models::StageSummary

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

Overview

stage summary of a remediation run. A stage is one step of a remediation run.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_DETECT = 'DETECT'.freeze,
  TYPE_RECOMMEND = 'RECOMMEND'.freeze,
  TYPE_VERIFY = 'VERIFY'.freeze,
  TYPE_APPLY = 'APPLY'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StageSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_started (DateTime) —

    The value to assign to the #time_started property

  • :time_finished (DateTime) —

    The value to assign to the #time_finished property

  • :type (String) —

    The value to assign to the #type property

  • :summary (String) —

    The value to assign to the #summary property



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/adm/models/stage_summary.rb', line 77

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

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

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

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

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

Instance Attribute Details

#summary ⇒ String

Information about the current step within the given stage.

Returns:

  • (String) 


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

def summary
  @summary
end

#time_created ⇒ DateTime

[Required] The creation date and time of the stage (formatted according to RFC3339).

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_finished ⇒ DateTime

The date and time of the finish of the stage (formatted according to RFC3339).

Returns:

  • (DateTime) 


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

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

The date and time of the start of the stage (formatted according to RFC3339).

Returns:

  • (DateTime) 


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

def time_started
  @time_started
end

#type ⇒ String

[Required] The type of stage.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/adm/models/stage_summary.rb', line 41

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_created': :'timeCreated',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'type': :'type',
    'summary': :'summary'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/adm/models/stage_summary.rb', line 54

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



126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/adm/models/stage_summary.rb', line 126

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

  self.class == other.class &&
    time_created == other.time_created &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    type == other.type &&
    summary == other.summary
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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/adm/models/stage_summary.rb', line 160

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


140
141
142
 
# File 'lib/oci/adm/models/stage_summary.rb', line 140

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



149
150
151
 
# File 'lib/oci/adm/models/stage_summary.rb', line 149

def hash
  [time_created, time_started, time_finished, type, summary].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/adm/models/stage_summary.rb', line 193

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



187
188
189
 
# File 'lib/oci/adm/models/stage_summary.rb', line 187

def to_s
  to_hash.to_s
end