Class: OCI::GoldenGate::Models::WorkRequest

Inherits:
Object
  • Object
show all
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_REFRESH = 'GOLDENGATE_CONNECTION_REFRESH'.freeze,
  OPERATION_TYPE_GOLDENGATE_CONNECTION_MIGRATE_SECRETS = 'GOLDENGATE_CONNECTION_MIGRATE_SECRETS'.freeze,
  OPERATION_TYPE_GOLDENGATE_CONNECTION_ASSIGNMENT_CREATE = 'GOLDENGATE_CONNECTION_ASSIGNMENT_CREATE'.freeze,
  OPERATION_TYPE_GOLDENGATE_CONNECTION_ASSIGNMENT_DELETE = 'GOLDENGATE_CONNECTION_ASSIGNMENT_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_GOLDENGATE_PIPELINE_CREATE = 'GOLDENGATE_PIPELINE_CREATE'.freeze,
  OPERATION_TYPE_GOLDENGATE_PIPELINE_START = 'GOLDENGATE_PIPELINE_START'.freeze,
  OPERATION_TYPE_GOLDENGATE_PIPELINE_STOP = 'GOLDENGATE_PIPELINE_STOP'.freeze,
  OPERATION_TYPE_GOLDENGATE_PIPELINE_UPDATE = 'GOLDENGATE_PIPELINE_UPDATE'.freeze,
  OPERATION_TYPE_GOLDENGATE_PIPELINE_DELETE = 'GOLDENGATE_PIPELINE_DELETE'.freeze,
  OPERATION_TYPE_GOLDENGATE_PIPELINE_MOVE = 'GOLDENGATE_PIPELINE_MOVE'.freeze,
  OPERATION_TYPE_GOLDENGATE_PIPELINE_DIAGNOSTICS_COLLECT = 'GOLDENGATE_PIPELINE_DIAGNOSTICS_COLLECT'.freeze,
  OPERATION_TYPE_GOLDENGATE_SWITCHOVER_DEPLOYMENT_PEER = 'GOLDENGATE_SWITCHOVER_DEPLOYMENT_PEER'.freeze,
  OPERATION_TYPE_GOLDENGATE_PIPELINE_PAUSE = 'GOLDENGATE_PIPELINE_PAUSE'.freeze,
  OPERATION_TYPE_GOLDENGATE_PIPELINE_CLONE = 'GOLDENGATE_PIPELINE_CLONE'.freeze,
  OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_DISASTER_RECOVERY_PRECHECK = 'GOLDENGATE_DEPLOYMENT_DISASTER_RECOVERY_PRECHECK'.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

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):



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
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 172

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.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 93

def compartment_id
  @compartment_id
end

#id ⇒ String

[Required] The id of the work request.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 85

def id
  @id
end

#operation_type ⇒ String

[Required] The work request's operation type.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 75

def operation_type
  @operation_type
end

#percent_complete ⇒ Float

[Required] Percentage of the request completed.

Returns:

  • (Float) 


103
104
105
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 103

def percent_complete
  @percent_complete
end

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

[Required] The resources affected by this work request.

Returns:



98
99
100
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 98

def resources
  @resources
end

#status ⇒ String

[Required] Status of current work request.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 80

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.

Returns:

  • (DateTime) 


109
110
111
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 109

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.

Returns:

  • (DateTime) 


121
122
123
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 121

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.

Returns:

  • (DateTime) 


115
116
117
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 115

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 124

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.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 141

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.

Parameters:

  • other (Object) —

    the other object to be compared



254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 254

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 292

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


272
273
274
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 272

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



281
282
283
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 281

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

Returns:

  • (Hash) —

    Returns the object in the form of hash



325
326
327
328
329
330
331
332
333
334
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 325

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



319
320
321
 
# File 'lib/oci/golden_gate/models/work_request.rb', line 319

def to_s
  to_hash.to_s
end