Class: OCI::Oda::Models::WorkRequest

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

Overview

The description of work request, including its status.

Constant Summary collapse

REQUEST_ACTION_ENUM = 
[
  REQUEST_ACTION_CREATE_ODA_INSTANCE = 'CREATE_ODA_INSTANCE'.freeze,
  REQUEST_ACTION_UPGRADE_ODA_INSTANCE = 'UPGRADE_ODA_INSTANCE'.freeze,
  REQUEST_ACTION_DELETE_ODA_INSTANCE = 'DELETE_ODA_INSTANCE'.freeze,
  REQUEST_ACTION_PURGE_ODA_INSTANCE = 'PURGE_ODA_INSTANCE'.freeze,
  REQUEST_ACTION_RECOVER_ODA_INSTANCE = 'RECOVER_ODA_INSTANCE'.freeze,
  REQUEST_ACTION_CHANGE_ODA_INSTANCE_COMPARTMENT = 'CHANGE_ODA_INSTANCE_COMPARTMENT'.freeze,
  REQUEST_ACTION_CREATE_ASSOCIATION = 'CREATE_ASSOCIATION'.freeze,
  REQUEST_ACTION_DELETE_ASSOCIATION = 'DELETE_ASSOCIATION'.freeze,
  REQUEST_ACTION_UPDATE_ENTITLEMENTS_FOR_CACCT = 'UPDATE_ENTITLEMENTS_FOR_CACCT'.freeze,
  REQUEST_ACTION_LOOKUP_ODA_INSTANCES_FOR_CACCT = 'LOOKUP_ODA_INSTANCES_FOR_CACCT'.freeze,
  REQUEST_ACTION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  STATUS_FAILED = 'FAILED'.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):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :oda_instance_id (String) —

    The value to assign to the #oda_instance_id property

  • :request_action (String) —

    The value to assign to the #request_action property

  • :status (String) —

    The value to assign to the #status property

  • :status_message (String) —

    The value to assign to the #status_message property

  • :resources (Array<OCI::Oda::Models::WorkRequestResource>) —

    The value to assign to the #resources property

  • :percent_complete (Float) —

    The value to assign to the #percent_complete property

  • :time_accepted (DateTime) —

    The value to assign to the #time_accepted 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



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
193
194
195
196
197
198
199
200
 
# File 'lib/oci/oda/models/work_request.rb', line 141

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

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

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

  self.request_action = attributes[:'requestAction'] if attributes[:'requestAction']

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

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

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

  self.status_message = attributes[:'statusMessage'] if attributes[:'statusMessage']

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/oda/models/work_request.rb', line 40

def compartment_id
  @compartment_id
end

#id ⇒ String

[Required] The identifier of the work request.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/oda/models/work_request.rb', line 36

def id
  @id
end

#oda_instance_id ⇒ String

[Required] The identifier of the Digital Assistant instance to which this work request pertains.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/oda/models/work_request.rb', line 44

def oda_instance_id
  @oda_instance_id
end

#percent_complete ⇒ Float

[Required] Percentage of the request completed.

Returns:

  • (Float) 


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

def percent_complete
  @percent_complete
end

#request_action ⇒ String

[Required] The type of the operation that’s associated with the work request.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/oda/models/work_request.rb', line 48

def request_action
  @request_action
end

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

[Required] The resources that this work request affects.

Returns:



63
64
65
 
# File 'lib/oci/oda/models/work_request.rb', line 63

def resources
  @resources
end

#status ⇒ String

[Required] The status of current work request.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/oda/models/work_request.rb', line 52

def status
  @status
end

#status_message ⇒ String

A short message that provides more detail about the current status. For example, if a work request fails, then this may include information about why it failed.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/oda/models/work_request.rb', line 59

def status_message
  @status_message
end

#time_accepted ⇒ DateTime

[Required] The date and time that the request was created, as described in [RFC 3339](tools.ietf.org/rfc/rfc3339), section 14.29.

Returns:

  • (DateTime) 


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

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

The date and time that the object finished, as described in [RFC 3339](tools.ietf.org/rfc/rfc3339). CKQ

Returns:

  • (DateTime) 


84
85
86
 
# File 'lib/oci/oda/models/work_request.rb', line 84

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

The date and time that the request was started, as described in [RFC 3339](tools.ietf.org/rfc/rfc3339), CKQ section 14.29.

Returns:

  • (DateTime) 


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

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'oda_instance_id': :'odaInstanceId',
    'request_action': :'requestAction',
    'status': :'status',
    'status_message': :'statusMessage',
    'resources': :'resources',
    'percent_complete': :'percentComplete',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished'
    # 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
122
 
# File 'lib/oci/oda/models/work_request.rb', line 106

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/oda/models/work_request.rb', line 235

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

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/oda/models/work_request.rb', line 275

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



264
265
266
 
# File 'lib/oci/oda/models/work_request.rb', line 264

def hash
  [id, compartment_id, oda_instance_id, request_action, status, status_message, resources, percent_complete, time_accepted, time_started, time_finished].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



308
309
310
311
312
313
314
315
316
317
 
# File 'lib/oci/oda/models/work_request.rb', line 308

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



302
303
304
 
# File 'lib/oci/oda/models/work_request.rb', line 302

def to_s
  to_hash.to_s
end