Class: OCI::Waas::Models::WorkRequest
- Inherits:
-
Object
- Object
- OCI::Waas::Models::WorkRequest
- Defined in:
- lib/oci/waas/models/work_request.rb
Overview
Many of the API requests you use to create and configure WAAS policies do not take effect immediately. In these cases, the request spawns an asynchronous work flow to fulfill the request. WorkRequest
objects provide visibility for in-progress work flows. For more information about work requests, see Viewing the State of a Work Request.
Constant Summary collapse
- OPERATION_TYPE_ENUM =
[ OPERATION_TYPE_CREATE_WAAS_POLICY = 'CREATE_WAAS_POLICY'.freeze, OPERATION_TYPE_UPDATE_WAAS_POLICY = 'UPDATE_WAAS_POLICY'.freeze, OPERATION_TYPE_DELETE_WAAS_POLICY = 'DELETE_WAAS_POLICY'.freeze, OPERATION_TYPE_CREATE_HTTP_REDIRECT = 'CREATE_HTTP_REDIRECT'.freeze, OPERATION_TYPE_UPDATE_HTTP_REDIRECT = 'UPDATE_HTTP_REDIRECT'.freeze, OPERATION_TYPE_DELETE_HTTP_REDIRECT = 'DELETE_HTTP_REDIRECT'.freeze, OPERATION_TYPE_PURGE_WAAS_POLICY_CACHE = 'PURGE_WAAS_POLICY_CACHE'.freeze, OPERATION_TYPE_CREATE_CUSTOM_PROTECTION_RULE = 'CREATE_CUSTOM_PROTECTION_RULE'.freeze, OPERATION_TYPE_UPDATE_CUSTOM_PROTECTION_RULE = 'UPDATE_CUSTOM_PROTECTION_RULE'.freeze, OPERATION_TYPE_DELETE_CUSTOM_PROTECTION_RULE = 'DELETE_CUSTOM_PROTECTION_RULE'.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 the work request.
-
#errors ⇒ Array<OCI::Waas::Models::WorkRequestError>
The list of errors that occurred while fulfilling the work request.
-
#id ⇒ String
[Required] The OCID of the work request.
-
#logs ⇒ Array<OCI::Waas::Models::WorkRequestLogEntry>
The list of log entries from the work request workflow.
-
#operation_type ⇒ String
[Required] A description of the operation requested by the work request.
-
#percent_complete ⇒ Integer
The percentage of work completed by the work request.
-
#resources ⇒ Array<OCI::Waas::Models::WorkRequestResource>
The resources being used to complete the work request operation.
-
#status ⇒ String
[Required] The current status of the work request.
-
#time_accepted ⇒ DateTime
[Required] The date and time the work request was created, in the format defined by RFC3339.
-
#time_finished ⇒ DateTime
[Required] The date and time the work request was fulfilled or terminated, expressed in RFC 3339 timestamp format.
-
#time_started ⇒ DateTime
[Required] The date and time the work request moved from the
ACCEPTED
state to theIN_PROGRESS
state, expressed in RFC 3339 timestamp format.
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
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 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/oci/waas/models/work_request.rb', line 134 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.status = attributes[:'status'] if attributes[:'status'] 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.logs = attributes[:'logs'] if attributes[:'logs'] self.errors = attributes[:'errors'] if attributes[:'errors'] 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.
49 50 51 |
# File 'lib/oci/waas/models/work_request.rb', line 49 def compartment_id @compartment_id end |
#errors ⇒ Array<OCI::Waas::Models::WorkRequestError>
The list of errors that occurred while fulfilling the work request.
65 66 67 |
# File 'lib/oci/waas/models/work_request.rb', line 65 def errors @errors end |
#id ⇒ String
[Required] The OCID of the work request.
37 38 39 |
# File 'lib/oci/waas/models/work_request.rb', line 37 def id @id end |
#logs ⇒ Array<OCI::Waas::Models::WorkRequestLogEntry>
The list of log entries from the work request workflow.
61 62 63 |
# File 'lib/oci/waas/models/work_request.rb', line 61 def logs @logs end |
#operation_type ⇒ String
[Required] A description of the operation requested by the work request.
41 42 43 |
# File 'lib/oci/waas/models/work_request.rb', line 41 def operation_type @operation_type end |
#percent_complete ⇒ Integer
The percentage of work completed by the work request.
57 58 59 |
# File 'lib/oci/waas/models/work_request.rb', line 57 def percent_complete @percent_complete end |
#resources ⇒ Array<OCI::Waas::Models::WorkRequestResource>
The resources being used to complete the work request operation.
53 54 55 |
# File 'lib/oci/waas/models/work_request.rb', line 53 def resources @resources end |
#status ⇒ String
[Required] The current status of the work request.
45 46 47 |
# File 'lib/oci/waas/models/work_request.rb', line 45 def status @status end |
#time_accepted ⇒ DateTime
[Required] The date and time the work request was created, in the format defined by RFC3339.
69 70 71 |
# File 'lib/oci/waas/models/work_request.rb', line 69 def time_accepted @time_accepted end |
#time_finished ⇒ DateTime
[Required] The date and time the work request was fulfilled or terminated, expressed in RFC 3339 timestamp format.
77 78 79 |
# File 'lib/oci/waas/models/work_request.rb', line 77 def time_finished @time_finished end |
#time_started ⇒ DateTime
[Required] The date and time the work request moved from the ACCEPTED
state to the IN_PROGRESS
state, expressed in RFC 3339 timestamp format.
73 74 75 |
# File 'lib/oci/waas/models/work_request.rb', line 73 def time_started @time_started end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/oci/waas/models/work_request.rb', line 80 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'operation_type': :'operationType', 'status': :'status', 'compartment_id': :'compartmentId', 'resources': :'resources', 'percent_complete': :'percentComplete', 'logs': :'logs', 'errors': :'errors', 'time_accepted': :'timeAccepted', 'time_started': :'timeStarted', 'time_finished': :'timeFinished' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/oci/waas/models/work_request.rb', line 99 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'operation_type': :'String', 'status': :'String', 'compartment_id': :'String', 'resources': :'Array<OCI::Waas::Models::WorkRequestResource>', 'percent_complete': :'Integer', 'logs': :'Array<OCI::Waas::Models::WorkRequestLogEntry>', 'errors': :'Array<OCI::Waas::Models::WorkRequestError>', '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.
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/oci/waas/models/work_request.rb', line 220 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && operation_type == other.operation_type && status == other.status && compartment_id == other.compartment_id && resources == other.resources && percent_complete == other.percent_complete && logs == other.logs && errors == other.errors && 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
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
# File 'lib/oci/waas/models/work_request.rb', line 260 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
240 241 242 |
# File 'lib/oci/waas/models/work_request.rb', line 240 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
249 250 251 |
# File 'lib/oci/waas/models/work_request.rb', line 249 def hash [id, operation_type, status, compartment_id, resources, percent_complete, logs, errors, time_accepted, time_started, time_finished].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
293 294 295 296 297 298 299 300 301 302 |
# File 'lib/oci/waas/models/work_request.rb', line 293 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
287 288 289 |
# File 'lib/oci/waas/models/work_request.rb', line 287 def to_s to_hash.to_s end |