Class: OCI::Identity::Models::WorkRequest

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

Overview

The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows.

Constant Summary collapse

OPERATION_TYPE_ENUM =

rubocop:disable Metrics/LineLength

[
  OPERATION_TYPE_DELETE_COMPARTMENT = 'DELETE_COMPARTMENT'.freeze,
  OPERATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.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):



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
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
 
# File 'lib/oci/identity/models/work_request.rb', line 136

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

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

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

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

  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.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']
end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment that contains the work request.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/identity/models/work_request.rb', line 37

def compartment_id
  @compartment_id
end

#errors ⇒ Array<OCI::Identity::Models::WorkRequestError>

The errors for work request.

Returns:



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

def errors
  @errors
end

#id ⇒ String

[Required] The OCID of the work request.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/identity/models/work_request.rb', line 29

def id
  @id
end

#logs ⇒ Array<OCI::Identity::Models::WorkRequestLogEntry>

The logs for work request.

Returns:



56
57
58
 
# File 'lib/oci/identity/models/work_request.rb', line 56

def logs
  @logs
end

#operation_type ⇒ String

[Required] An enum-like description of the type of work the work request is doing.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/identity/models/work_request.rb', line 33

def operation_type
  @operation_type
end

#percent_complete ⇒ Float

How much progress the operation has made.

Returns:

  • (Float) 


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

def percent_complete
  @percent_complete
end

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

The resources this work request affects.

Returns:



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

def resources
  @resources
end

#status ⇒ String

[Required] The current status of the work request.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/identity/models/work_request.rb', line 41

def status
  @status
end

#time_accepted ⇒ DateTime

Date and time the work was accepted, in the format defined by RFC3339. Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/identity/models/work_request.rb', line 62

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

Date and time the work completed, in the format defined by RFC3339. Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


74
75
76
 
# File 'lib/oci/identity/models/work_request.rb', line 74

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

Date and time the work started, in the format defined by RFC3339. Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/identity/models/work_request.rb', line 68

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/identity/models/work_request.rb', line 101

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



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

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

  self.class == other.class &&
    id == other.id &&
    operation_type == other.operation_type &&
    compartment_id == other.compartment_id &&
    status == other.status &&
    resources == other.resources &&
    errors == other.errors &&
    logs == other.logs &&
    time_accepted == other.time_accepted &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    percent_complete == other.percent_complete
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/identity/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/identity/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/identity/models/work_request.rb', line 255

def hash
  [id, operation_type, compartment_id, status, resources, errors, logs, time_accepted, time_started, time_finished, percent_complete].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/identity/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/identity/models/work_request.rb', line 293

def to_s
  to_hash.to_s
end