Class: OCI::DisasterRecovery::Models::WorkRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/disaster_recovery/models/work_request.rb

Overview

Information on a work request.

Constant Summary collapse

OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_CREATE_DR_PROTECTION_GROUP = 'CREATE_DR_PROTECTION_GROUP'.freeze,
  OPERATION_TYPE_UPDATE_DR_PROTECTION_GROUP = 'UPDATE_DR_PROTECTION_GROUP'.freeze,
  OPERATION_TYPE_DELETE_DR_PROTECTION_GROUP = 'DELETE_DR_PROTECTION_GROUP'.freeze,
  OPERATION_TYPE_MOVE_DR_PROTECTION_GROUP = 'MOVE_DR_PROTECTION_GROUP'.freeze,
  OPERATION_TYPE_ASSOCIATE_DR_PROTECTION_GROUP = 'ASSOCIATE_DR_PROTECTION_GROUP'.freeze,
  OPERATION_TYPE_DISASSOCIATE_DR_PROTECTION_GROUP = 'DISASSOCIATE_DR_PROTECTION_GROUP'.freeze,
  OPERATION_TYPE_UPDATE_ROLE_DR_PROTECTION_GROUP = 'UPDATE_ROLE_DR_PROTECTION_GROUP'.freeze,
  OPERATION_TYPE_CREATE_DR_PLAN = 'CREATE_DR_PLAN'.freeze,
  OPERATION_TYPE_UPDATE_DR_PLAN = 'UPDATE_DR_PLAN'.freeze,
  OPERATION_TYPE_DELETE_DR_PLAN = 'DELETE_DR_PLAN'.freeze,
  OPERATION_TYPE_CREATE_DR_PLAN_EXECUTION = 'CREATE_DR_PLAN_EXECUTION'.freeze,
  OPERATION_TYPE_UPDATE_DR_PLAN_EXECUTION = 'UPDATE_DR_PLAN_EXECUTION'.freeze,
  OPERATION_TYPE_DELETE_DR_PLAN_EXECUTION = 'DELETE_DR_PLAN_EXECUTION'.freeze,
  OPERATION_TYPE_RETRY_DR_PLAN_EXECUTION = 'RETRY_DR_PLAN_EXECUTION'.freeze,
  OPERATION_TYPE_IGNORE_DR_PLAN_EXECUTION = 'IGNORE_DR_PLAN_EXECUTION'.freeze,
  OPERATION_TYPE_CANCEL_DR_PLAN_EXECUTION = 'CANCEL_DR_PLAN_EXECUTION'.freeze,
  OPERATION_TYPE_PAUSE_DR_PLAN_EXECUTION = 'PAUSE_DR_PLAN_EXECUTION'.freeze,
  OPERATION_TYPE_RESUME_DR_PLAN_EXECUTION = 'RESUME_DR_PLAN_EXECUTION'.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_CANCELING = 'CANCELING'.freeze,
  STATUS_CANCELED = 'CANCELED'.freeze,
  STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.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):



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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 155

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

Example: ocid1.compartment.oc1..uniqueID

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 71

def compartment_id
  @compartment_id
end

#id ⇒ String

[Required] The OCID of the work request.

Example: ocid1.drworkrequest.oc1..uniqueID

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 61

def id
  @id
end

#operation_type ⇒ String

[Required] The type of the work request.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 49

def operation_type
  @operation_type
end

#percent_complete ⇒ Float

[Required] The percentage of the request completed.

Example: 75

Returns:

  • (Float) 


83
84
85
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 83

def percent_complete
  @percent_complete
end

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

[Required] The resources affected by this work request.

Returns:



76
77
78
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 76

def resources
  @resources
end

#status ⇒ String

[Required] The status of work request.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 54

def status
  @status
end

#time_accepted ⇒ DateTime

[Required] The date and time the request was created. An RFC3339 formatted datetime string.

Example: 2019-03-29T09:36:42Z

Returns:

  • (DateTime) 


90
91
92
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 90

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

The date and time the request was finished. An RFC3339 formatted datetime string.

Example: 2019-03-29T09:36:42Z

Returns:

  • (DateTime) 


104
105
106
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 104

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

The date and time the request was started. An RFC3339 formatted datetime string.

Example: 2019-03-29T09:36:42Z

Returns:

  • (DateTime) 


97
98
99
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 97

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 107

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.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'operation_type': :'String',
    'status': :'String',
    'id': :'String',
    'compartment_id': :'String',
    'resources': :'Array<OCI::DisasterRecovery::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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 237

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 275

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


255
256
257
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 255

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



264
265
266
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 264

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



308
309
310
311
312
313
314
315
316
317
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 308

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



302
303
304
 
# File 'lib/oci/disaster_recovery/models/work_request.rb', line 302

def to_s
  to_hash.to_s
end