Class: OCI::GenerativeAi::Models::WorkRequest
- Inherits:
-
Object
- Object
- OCI::GenerativeAi::Models::WorkRequest
- Defined in:
- lib/oci/generative_ai/models/work_request.rb
Overview
An asynchronous work request. When you start a long-running operation, the service creates a work request. Work requests help you monitor long-running operations.
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_CREATE_MODEL = 'CREATE_MODEL'.freeze, OPERATION_TYPE_DELETE_MODEL = 'DELETE_MODEL'.freeze, OPERATION_TYPE_MOVE_MODEL = 'MOVE_MODEL'.freeze, OPERATION_TYPE_CREATE_DEDICATED_AI_CLUSTER = 'CREATE_DEDICATED_AI_CLUSTER'.freeze, OPERATION_TYPE_DELETE_DEDICATED_AI_CLUSTER = 'DELETE_DEDICATED_AI_CLUSTER'.freeze, OPERATION_TYPE_UPDATE_DEDICATED_AI_CLUSTER = 'UPDATE_DEDICATED_AI_CLUSTER'.freeze, OPERATION_TYPE_MOVE_DEDICATED_AI_CLUSTER = 'MOVE_DEDICATED_AI_CLUSTER'.freeze, OPERATION_TYPE_CREATE_ENDPOINT = 'CREATE_ENDPOINT'.freeze, OPERATION_TYPE_DELETE_ENDPOINT = 'DELETE_ENDPOINT'.freeze, OPERATION_TYPE_UPDATE_ENDPOINT = 'UPDATE_ENDPOINT'.freeze, OPERATION_TYPE_MOVE_ENDPOINT = 'MOVE_ENDPOINT'.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_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
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the work request.
-
#id ⇒ String
[Required] The OCID of the work request.
-
#operation_type ⇒ String
[Required] The asynchronous operation tracked by this work request.
-
#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.
-
#resources ⇒ Array<OCI::GenerativeAi::Models::WorkRequestResource>
[Required] The resources that are affected by the work request.
-
#status ⇒ String
[Required] The status of the work request.
-
#time_accepted ⇒ DateTime
[Required] The date and time the work request was created, in the format defined by RFC 3339.
-
#time_finished ⇒ DateTime
The date and time the work request was finished, in the format defined by RFC 3339.
-
#time_started ⇒ DateTime
The date and time the work request was started, in the format defined by RFC 3339.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ WorkRequest
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ WorkRequest
Initializes the object
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 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 135 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'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the work request.
56 57 58 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 56 def compartment_id @compartment_id end |
#id ⇒ String
[Required] The OCID of the work request.
51 52 53 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 51 def id @id end |
#operation_type ⇒ String
[Required] The asynchronous operation tracked by this work request.
43 44 45 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 43 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.
66 67 68 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 66 def percent_complete @percent_complete end |
#resources ⇒ Array<OCI::GenerativeAi::Models::WorkRequestResource>
[Required] The resources that are affected by the work request.
60 61 62 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 60 def resources @resources end |
#status ⇒ String
[Required] The status of the work request.
47 48 49 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 47 def status @status end |
#time_accepted ⇒ DateTime
[Required] The date and time the work request was created, in the format defined by RFC 3339.
72 73 74 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 72 def time_accepted @time_accepted end |
#time_finished ⇒ DateTime
The date and time the work request was finished, in the format defined by RFC 3339.
84 85 86 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 84 def time_finished @time_finished end |
#time_started ⇒ DateTime
The date and time the work request was started, in the format defined by RFC 3339.
78 79 80 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 78 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 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 87 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' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 104 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'operation_type': :'String', 'status': :'String', 'id': :'String', 'compartment_id': :'String', 'resources': :'Array<OCI::GenerativeAi::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.
217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 217 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 end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 255 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
235 236 237 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 235 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
244 245 246 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 244 def hash [operation_type, status, id, compartment_id, resources, percent_complete, time_accepted, time_started, time_finished].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
288 289 290 291 292 293 294 295 296 297 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 288 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
282 283 284 |
# File 'lib/oci/generative_ai/models/work_request.rb', line 282 def to_s to_hash.to_s end |