Class: OCI::DataIntegration::Models::WorkRequest
- Inherits:
-
Object
- Object
- OCI::DataIntegration::Models::WorkRequest
- Defined in:
- lib/oci/data_integration/models/work_request.rb
Overview
The API operations used to create and configure Data Integration resources do not take effect immediately. In these cases, the operation spawns an asynchronous workflow to fulfill the request. Work requests provide visibility into the status of these in-progress, long-running asynchronous workflows.
Constant Summary collapse
- OPERATION_TYPE_ENUM =
[ OPERATION_TYPE_CREATE_WORKSPACE = 'CREATE_WORKSPACE'.freeze, OPERATION_TYPE_UPDATE_WORKSPACE = 'UPDATE_WORKSPACE'.freeze, OPERATION_TYPE_DELETE_WORKSPACE = 'DELETE_WORKSPACE'.freeze, OPERATION_TYPE_MOVE_WORKSPACE = 'MOVE_WORKSPACE'.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
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains this work request.
-
#id ⇒ String
[Required] The ID of the work request.
-
#operation_type ⇒ String
[Required] The asynchronous operation tracked by this work request.
-
#percent_complete ⇒ Float
[Required] The completed percentage of the operation tracked by this work request.
-
#resources ⇒ Array<OCI::DataIntegration::Models::WorkRequestResource>
[Required] The resources affected by this work request.
-
#status ⇒ String
[Required] The status of this work request.
-
#time_accepted ⇒ DateTime
[Required] The date and time this work request was accepted, in the timestamp format defined by RFC 3339.
-
#time_finished ⇒ DateTime
The date and time the work request reached a terminal state, either
FAILED
orSUCCEEDED
, in the timestamp format defined by RFC 3339. -
#time_started ⇒ DateTime
The date and time the work request transitioned from
ACCEPTED
toIN_PROGRESS
, in the timestamp 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
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 163 164 165 166 167 168 169 |
# File 'lib/oci/data_integration/models/work_request.rb', line 122 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 this work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources that are not in the same compartment, then the system picks a primary resource whose compartment should be used.
47 48 49 |
# File 'lib/oci/data_integration/models/work_request.rb', line 47 def compartment_id @compartment_id end |
#id ⇒ String
[Required] The ID of the work request.
40 41 42 |
# File 'lib/oci/data_integration/models/work_request.rb', line 40 def id @id end |
#operation_type ⇒ String
[Required] The asynchronous operation tracked by this work request.
32 33 34 |
# File 'lib/oci/data_integration/models/work_request.rb', line 32 def operation_type @operation_type end |
#percent_complete ⇒ Float
[Required] The completed percentage of the operation tracked by this work request.
55 56 57 |
# File 'lib/oci/data_integration/models/work_request.rb', line 55 def percent_complete @percent_complete end |
#resources ⇒ Array<OCI::DataIntegration::Models::WorkRequestResource>
[Required] The resources affected by this work request.
51 52 53 |
# File 'lib/oci/data_integration/models/work_request.rb', line 51 def resources @resources end |
#status ⇒ String
[Required] The status of this work request.
36 37 38 |
# File 'lib/oci/data_integration/models/work_request.rb', line 36 def status @status end |
#time_accepted ⇒ DateTime
[Required] The date and time this work request was accepted, in the timestamp format defined by RFC 3339.
61 62 63 |
# File 'lib/oci/data_integration/models/work_request.rb', line 61 def time_accepted @time_accepted end |
#time_finished ⇒ DateTime
The date and time the work request reached a terminal state, either FAILED
or SUCCEEDED
, in the timestamp format defined by RFC 3339.
71 72 73 |
# File 'lib/oci/data_integration/models/work_request.rb', line 71 def time_finished @time_finished end |
#time_started ⇒ DateTime
The date and time the work request transitioned from ACCEPTED
to IN_PROGRESS
, in the timestamp format defined by RFC 3339.
66 67 68 |
# File 'lib/oci/data_integration/models/work_request.rb', line 66 def time_started @time_started end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/oci/data_integration/models/work_request.rb', line 74 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.
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/oci/data_integration/models/work_request.rb', line 91 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'operation_type': :'String', 'status': :'String', 'id': :'String', 'compartment_id': :'String', 'resources': :'Array<OCI::DataIntegration::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.
204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/oci/data_integration/models/work_request.rb', line 204 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
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/oci/data_integration/models/work_request.rb', line 242 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
222 223 224 |
# File 'lib/oci/data_integration/models/work_request.rb', line 222 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
231 232 233 |
# File 'lib/oci/data_integration/models/work_request.rb', line 231 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
275 276 277 278 279 280 281 282 283 284 |
# File 'lib/oci/data_integration/models/work_request.rb', line 275 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
269 270 271 |
# File 'lib/oci/data_integration/models/work_request.rb', line 269 def to_s to_hash.to_s end |