Class: OCI::GoldenGate::Models::WorkRequest
- Inherits:
-
Object
- Object
- OCI::GoldenGate::Models::WorkRequest
- Defined in:
- lib/oci/golden_gate/models/work_request.rb
Overview
The API operations that create and configure GoldenGate 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_GOLDENGATE_DATABASE_REGISTRATION_CREATE = 'GOLDENGATE_DATABASE_REGISTRATION_CREATE'.freeze, OPERATION_TYPE_GOLDENGATE_DATABASE_REGISTRATION_UPDATE = 'GOLDENGATE_DATABASE_REGISTRATION_UPDATE'.freeze, OPERATION_TYPE_GOLDENGATE_DATABASE_REGISTRATION_DELETE = 'GOLDENGATE_DATABASE_REGISTRATION_DELETE'.freeze, OPERATION_TYPE_GOLDENGATE_DATABASE_REGISTRATION_MOVE = 'GOLDENGATE_DATABASE_REGISTRATION_MOVE'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_CREATE = 'GOLDENGATE_DEPLOYMENT_CREATE'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_UPDATE = 'GOLDENGATE_DEPLOYMENT_UPDATE'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_DELETE = 'GOLDENGATE_DEPLOYMENT_DELETE'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_MOVE = 'GOLDENGATE_DEPLOYMENT_MOVE'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_RESTORE = 'GOLDENGATE_DEPLOYMENT_RESTORE'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_START = 'GOLDENGATE_DEPLOYMENT_START'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_STOP = 'GOLDENGATE_DEPLOYMENT_STOP'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_UPGRADE = 'GOLDENGATE_DEPLOYMENT_UPGRADE'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_BACKUP_CREATE = 'GOLDENGATE_DEPLOYMENT_BACKUP_CREATE'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_BACKUP_DELETE = 'GOLDENGATE_DEPLOYMENT_BACKUP_DELETE'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL = 'GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_BACKUP_COPY = 'GOLDENGATE_DEPLOYMENT_BACKUP_COPY'.freeze, OPERATION_TYPE_GOLDENGATE_CONNECTION_CREATE = 'GOLDENGATE_CONNECTION_CREATE'.freeze, OPERATION_TYPE_GOLDENGATE_CONNECTION_UPDATE = 'GOLDENGATE_CONNECTION_UPDATE'.freeze, OPERATION_TYPE_GOLDENGATE_CONNECTION_DELETE = 'GOLDENGATE_CONNECTION_DELETE'.freeze, OPERATION_TYPE_GOLDENGATE_CONNECTION_MOVE = 'GOLDENGATE_CONNECTION_MOVE'.freeze, OPERATION_TYPE_GOLDENGATE_CONNECTION_ASSIGNMENT_CREATE = 'GOLDENGATE_CONNECTION_ASSIGNMENT_CREATE'.freeze, OPERATION_TYPE_GOLDENGATE_CONNECTION_ASSIGMNENT_DELETE = 'GOLDENGATE_CONNECTION_ASSIGMNENT_DELETE'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_DIAGNOSTIC_COLLECT = 'GOLDENGATE_DEPLOYMENT_DIAGNOSTIC_COLLECT'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_WALLET_EXPORT = 'GOLDENGATE_DEPLOYMENT_WALLET_EXPORT'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_WALLET_IMPORT = 'GOLDENGATE_DEPLOYMENT_WALLET_IMPORT'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_UPGRADE_UPGRADE = 'GOLDENGATE_DEPLOYMENT_UPGRADE_UPGRADE'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_UPGRADE_ROLLBACK = 'GOLDENGATE_DEPLOYMENT_UPGRADE_ROLLBACK'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_UPGRADE_SNOOZE = 'GOLDENGATE_DEPLOYMENT_UPGRADE_SNOOZE'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_CERTIFICATE_CREATE = 'GOLDENGATE_DEPLOYMENT_CERTIFICATE_CREATE'.freeze, OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_CERTIFICATE_DELETE = 'GOLDENGATE_DEPLOYMENT_CERTIFICATE_DELETE'.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_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 id of the work request.
-
#operation_type ⇒ String
[Required] The work request's operation type.
-
#percent_complete ⇒ Float
[Required] Percentage of the request completed.
-
#resources ⇒ Array<OCI::GoldenGate::Models::WorkRequestResource>
[Required] The resources affected by this work request.
-
#status ⇒ String
[Required] Status of current work request.
-
#time_accepted ⇒ DateTime
[Required] The date and time the request was created.
-
#time_finished ⇒ DateTime
The date and time the request was finished.
-
#time_started ⇒ DateTime
The date and time the request was started.
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
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 201 202 203 204 205 206 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 159 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. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
80 81 82 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 80 def compartment_id @compartment_id end |
#id ⇒ String
[Required] The id of the work request.
72 73 74 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 72 def id @id end |
#operation_type ⇒ String
[Required] The work request's operation type.
62 63 64 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 62 def operation_type @operation_type end |
#percent_complete ⇒ Float
[Required] Percentage of the request completed.
90 91 92 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 90 def percent_complete @percent_complete end |
#resources ⇒ Array<OCI::GoldenGate::Models::WorkRequestResource>
[Required] The resources affected by this work request.
85 86 87 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 85 def resources @resources end |
#status ⇒ String
[Required] Status of current work request.
67 68 69 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 67 def status @status end |
#time_accepted ⇒ DateTime
[Required] The date and time the request was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z
.
96 97 98 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 96 def time_accepted @time_accepted end |
#time_finished ⇒ DateTime
The date and time the request was finished. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z
.
108 109 110 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 108 def time_finished @time_finished end |
#time_started ⇒ DateTime
The date and time the request was started. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z
.
102 103 104 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 102 def time_started @time_started end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 111 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.
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 128 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'operation_type': :'String', 'status': :'String', 'id': :'String', 'compartment_id': :'String', 'resources': :'Array<OCI::GoldenGate::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.
241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 241 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
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 279 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
259 260 261 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 259 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
268 269 270 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 268 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
312 313 314 315 316 317 318 319 320 321 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 312 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
306 307 308 |
# File 'lib/oci/golden_gate/models/work_request.rb', line 306 def to_s to_hash.to_s end |