Class: OCI::ResourceScheduler::Models::WorkRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/resource_scheduler/models/work_request.rb

Overview

This is an asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.

Constant Summary collapse

OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_START_RESOURCE = 'START_RESOURCE'.freeze,
  OPERATION_TYPE_STOP_RESOURCE = 'STOP_RESOURCE'.freeze,
  OPERATION_TYPE_CHANGE_SCHEDULE_COMPARTMENT = 'CHANGE_SCHEDULE_COMPARTMENT'.freeze,
  OPERATION_TYPE_CREATE_SCHEDULE = 'CREATE_SCHEDULE'.freeze,
  OPERATION_TYPE_UPDATE_SCHEDULE = 'UPDATE_SCHEDULE'.freeze,
  OPERATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_WAITING = 'WAITING'.freeze,
  STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  STATUS_CANCELING = 'CANCELING'.freeze,
  STATUS_CANCELED = 'CANCELED'.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 = {}) ⇒ WorkRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
188
189
190
191
192
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 139

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

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

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

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

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

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

  self.percent_complete = attributes[:'percentComplete'] if attributes[:'percentComplete']

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

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

  self.time_accepted = attributes[:'timeAccepted'] if attributes[:'timeAccepted']

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

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the work request.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 51

def compartment_id
  @compartment_id
end

#id ⇒ String

[Required] The OCID of the work request.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 46

def id
  @id
end

#operation_type ⇒ String

[Required] The asynchronous operation tracked by this work request.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 38

def operation_type
  @operation_type
end

#percent_complete ⇒ Float

[Required] Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed.

Returns:

  • (Float) 


61
62
63
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 61

def percent_complete
  @percent_complete
end

#resources ⇒ Array<OCI::ResourceScheduler::Models::WorkRequestResource>

[Required] This is the resources that are affected by the work request.

Returns:



55
56
57
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 55

def resources
  @resources
end

#status ⇒ String

[Required] This is the status of the work request.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 42

def status
  @status
end

#time_accepted ⇒ DateTime

[Required] This is the date and time the work request was created, in the format defined by RFC 3339.

Returns:

  • (DateTime) 


67
68
69
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 67

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

This is the date and time the work request was finished, in the format defined by RFC 3339.

Returns:

  • (DateTime) 


79
80
81
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 79

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

This is the date and time the work request was started, in the format defined by RFC 3339.

Returns:

  • (DateTime) 


73
74
75
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 73

def time_started
  @time_started
end

#time_updated ⇒ DateTime

This is the date and time the work request was updated, in the format defined by RFC 3339.

Returns:

  • (DateTime) 


85
86
87
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 85

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 88

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'operation_type': :'operationType',
    'status': :'status',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'resources': :'resources',
    'percent_complete': :'percentComplete',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 106

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'operation_type': :'String',
    'status': :'String',
    'id': :'String',
    'compartment_id': :'String',
    'resources': :'Array<OCI::ResourceScheduler::Models::WorkRequestResource>',
    'percent_complete': :'Float',
    'time_accepted': :'DateTime',
    'time_started': :'DateTime',
    'time_finished': :'DateTime',
    'time_updated': :'DateTime'
    # 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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 227

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

  self.class == other.class &&
    operation_type == other.operation_type &&
    status == other.status &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    resources == other.resources &&
    percent_complete == other.percent_complete &&
    time_accepted == other.time_accepted &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    time_updated == other.time_updated
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 266

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


246
247
248
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 246

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 255

def hash
  [operation_type, status, id, compartment_id, resources, percent_complete, time_accepted, time_started, time_finished, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 299

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



293
294
295
 
# File 'lib/oci/resource_scheduler/models/work_request.rb', line 293

def to_s
  to_hash.to_s
end