Class: OCI::FleetAppsManagement::Models::StepSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/models/step_summary.rb

Overview

Task associated with the Job.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  STATUS_WAITING = 'WAITING'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  STATUS_CANCELED = 'CANCELED'.freeze,
  STATUS_SKIPPED = 'SKIPPED'.freeze,
  STATUS_IGNORED = 'IGNORED'.freeze,
  STATUS_NOT_APPLICABLE = 'NOT_APPLICABLE'.freeze,
  STATUS_ABORTED = 'ABORTED'.freeze,
  STATUS_TIMED_OUT = 'TIMED_OUT'.freeze,
  STATUS_PAUSED = 'PAUSED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StepSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :task_record_id (String) —

    The value to assign to the #task_record_id property

  • :step_name (String) —

    The value to assign to the #step_name property

  • :sequence (String) —

    The value to assign to the #sequence property

  • :status (String) —

    The value to assign to the #status property

  • :time_started (DateTime) —

    The value to assign to the #time_started property

  • :time_ended (DateTime) —

    The value to assign to the #time_ended property

  • :is_rollback_task (BOOLEAN) —

    The value to assign to the #is_rollback_task property

  • :description (String) —

    The value to assign to the #description property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



115
116
117
118
119
120
121
122
123
124
125
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
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 115

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

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

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

  self.step_name = attributes[:'stepName'] if attributes[:'stepName']

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

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

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

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

  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_ended = attributes[:'timeEnded'] if attributes[:'timeEnded']

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

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

  self.is_rollback_task = attributes[:'isRollbackTask'] unless attributes[:'isRollbackTask'].nil?

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

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#description ⇒ String

Description of the step Execution.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 58

def description
  @description
end

#is_rollback_task ⇒ BOOLEAN

Is this a rollback task?

Returns:

  • (BOOLEAN) 


54
55
56
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 54

def is_rollback_task
  @is_rollback_task
end

#sequence ⇒ String

The sequence of the step.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 38

def sequence
  @sequence
end

#status ⇒ String

[Required] Status of the Task.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 42

def status
  @status
end

#step_name ⇒ String

[Required] Name of the Step.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 34

def step_name
  @step_name
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


64
65
66
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 64

def system_tags
  @system_tags
end

#task_record_id ⇒ String

The OCID of taskRecord assocaited with the step.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 30

def task_record_id
  @task_record_id
end

#time_ended ⇒ DateTime

The time the task ended. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


50
51
52
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 50

def time_ended
  @time_ended
end

#time_started ⇒ DateTime

The time the task started. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


46
47
48
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 46

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 67

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'task_record_id': :'taskRecordId',
    'step_name': :'stepName',
    'sequence': :'sequence',
    'status': :'status',
    'time_started': :'timeStarted',
    'time_ended': :'timeEnded',
    'is_rollback_task': :'isRollbackTask',
    'description': :'description',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 84

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'task_record_id': :'String',
    'step_name': :'String',
    'sequence': :'String',
    'status': :'String',
    'time_started': :'DateTime',
    'time_ended': :'DateTime',
    'is_rollback_task': :'BOOLEAN',
    'description': :'String',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 184

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

  self.class == other.class &&
    task_record_id == other.task_record_id &&
    step_name == other.step_name &&
    sequence == other.sequence &&
    status == other.status &&
    time_started == other.time_started &&
    time_ended == other.time_ended &&
    is_rollback_task == other.is_rollback_task &&
    description == other.description &&
    system_tags == other.system_tags
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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 222

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


202
203
204
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 202

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 211

def hash
  [task_record_id, step_name, sequence, status, time_started, time_ended, is_rollback_task, description, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 255

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



249
250
251
 
# File 'lib/oci/fleet_apps_management/models/step_summary.rb', line 249

def to_s
  to_hash.to_s
end