Class: OCI::Datacc::Models::WorkRequest

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

Overview

Work request details.

Constant Summary collapse

OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_CREATE_INSTANCE = 'CREATE_INSTANCE'.freeze,
  OPERATION_TYPE_DELETE_INSTANCE = 'DELETE_INSTANCE'.freeze,
  OPERATION_TYPE_UPDATE_INSTANCE = 'UPDATE_INSTANCE'.freeze,
  OPERATION_TYPE_CHANGE_INSTANCE_COMPARTMENT = 'CHANGE_INSTANCE_COMPARTMENT'.freeze,
  OPERATION_TYPE_CREATE_BASE_VM_CLUSTER_NETWORK = 'CREATE_BASE_VM_CLUSTER_NETWORK'.freeze,
  OPERATION_TYPE_DELETE_BASE_VM_CLUSTER_NETWORK = 'DELETE_BASE_VM_CLUSTER_NETWORK'.freeze,
  OPERATION_TYPE_VALIDATE_BASE_VM_CLUSTER_NETWORK = 'VALIDATE_BASE_VM_CLUSTER_NETWORK'.freeze,
  OPERATION_TYPE_UPDATE_BASE_VM_CLUSTER_NETWORK = 'UPDATE_BASE_VM_CLUSTER_NETWORK'.freeze,
  OPERATION_TYPE_CHANGE_BASE_VM_CLUSTER_NETWORK_COMPARTMENT = 'CHANGE_BASE_VM_CLUSTER_NETWORK_COMPARTMENT'.freeze,
  OPERATION_TYPE_START_BASE_VM = 'START_BASE_VM'.freeze,
  OPERATION_TYPE_STOP_BASE_VM = 'STOP_BASE_VM'.freeze,
  OPERATION_TYPE_START_INSTANCE = 'START_INSTANCE'.freeze,
  OPERATION_TYPE_STOP_INSTANCE = 'STOP_INSTANCE'.freeze,
  OPERATION_TYPE_SCALE_INSTANCE = 'SCALE_INSTANCE'.freeze,
  OPERATION_TYPE_RESTART_INSTANCE = 'RESTART_INSTANCE'.freeze,
  OPERATION_TYPE_RESTART_BASE_VM = 'RESTART_BASE_VM'.freeze,
  OPERATION_TYPE_MIGRATE_INSTANCE = 'MIGRATE_INSTANCE'.freeze,
  OPERATION_TYPE_SCALE_BASE_VM = 'SCALE_BASE_VM'.freeze,
  OPERATION_TYPE_UPDATE_SOFTWARE_IMAGE = 'UPDATE_SOFTWARE_IMAGE'.freeze,
  OPERATION_TYPE_CHANGE_SOFTWARE_IMAGE_COMPARTMENT = 'CHANGE_SOFTWARE_IMAGE_COMPARTMENT'.freeze,
  OPERATION_TYPE_VALIDATE_PROXY = 'VALIDATE_PROXY'.freeze,
  OPERATION_TYPE_CREATE_BASE_INFRA_CAPACITY = 'CREATE_BASE_INFRA_CAPACITY'.freeze,
  OPERATION_TYPE_UPDATE_BASE_INFRA_CAPACITY = 'UPDATE_BASE_INFRA_CAPACITY'.freeze,
  OPERATION_TYPE_DELETE_BASE_INFRA_CAPACITY = 'DELETE_BASE_INFRA_CAPACITY'.freeze,
  OPERATION_TYPE_ACTIVATE_BASE_INFRASTRUCTURE = 'ACTIVATE_BASE_INFRASTRUCTURE'.freeze,
  OPERATION_TYPE_CREATE_BASE_INFRASTRUCTURE = 'CREATE_BASE_INFRASTRUCTURE'.freeze,
  OPERATION_TYPE_DELETE_BASE_INFRASTRUCTURE = 'DELETE_BASE_INFRASTRUCTURE'.freeze,
  OPERATION_TYPE_UPDATE_BASE_INFRASTRUCTURE = 'UPDATE_BASE_INFRASTRUCTURE'.freeze,
  OPERATION_TYPE_UPDATE_BASE_INFRASTRUCTURE_SOFTWARE = 'UPDATE_BASE_INFRASTRUCTURE_SOFTWARE'.freeze,
  OPERATION_TYPE_VALIDATE_BASE_INFRASTRUCTURE = 'VALIDATE_BASE_INFRASTRUCTURE'.freeze,
  OPERATION_TYPE_CHANGE_BASE_INFRASTRUCTURE_COMPARTMENT = 'CHANGE_BASE_INFRASTRUCTURE_COMPARTMENT'.freeze,
  OPERATION_TYPE_ANALYZE_INFRASTRUCTURE = 'ANALYZE_INFRASTRUCTURE'.freeze,
  OPERATION_TYPE_ANALYZE_BASE_INFRA_NETWORK = 'ANALYZE_BASE_INFRA_NETWORK'.freeze,
  OPERATION_TYPE_INFRASTRUCTURE_SRE_VALIDATION = 'INFRASTRUCTURE_SRE_VALIDATION'.freeze,
  OPERATION_TYPE_CREATE_MAINTENANCE_RUN = 'CREATE_MAINTENANCE_RUN'.freeze,
  OPERATION_TYPE_UPDATE_MAINTENANCE_RUN = 'UPDATE_MAINTENANCE_RUN'.freeze,
  OPERATION_TYPE_RESCHEDULE_MAINTENANCE_RUN = 'RESCHEDULE_MAINTENANCE_RUN'.freeze,
  OPERATION_TYPE_INFRASTRUCTURE_SCALE_STORAGE = 'INFRASTRUCTURE_SCALE_STORAGE'.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_WAITING = 'WAITING'.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):

  • :operation_type (String) —

    The value to assign to the #operation_type property

  • :status (String) —

    The value to assign to the #status property

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :resources (Array<OCI::Datacc::Models::WorkRequestResource>) —

    The value to assign to the #resources property

  • :opc_request_id (String) —

    The value to assign to the #opc_request_id property

  • :percent_complete (Float) —

    The value to assign to the #percent_complete property

  • :time_accepted (DateTime) —

    The value to assign to the #time_accepted property

  • :time_started (DateTime) —

    The value to assign to the #time_started property

  • :time_finished (DateTime) —

    The value to assign to the #time_finished property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/datacc/models/work_request.rb', line 190

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.opc_request_id = attributes[:'opcRequestId'] if attributes[:'opcRequestId']

  raise 'You cannot provide both :opcRequestId and :opc_request_id' if attributes.key?(:'opcRequestId') && attributes.key?(:'opc_request_id')

  self.opc_request_id = attributes[:'opc_request_id'] if attributes[:'opc_request_id']

  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']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] OCID of the compartment that contains the work request.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


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

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the work request.

Returns:

  • (String) 


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

def id
  @id
end

#opc_request_id ⇒ String

opc-request-id of the request that triggered the work request.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/datacc/models/work_request.rb', line 88

def opc_request_id
  @opc_request_id
end

#operation_type ⇒ String

[Required] Type of the work request.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/datacc/models/work_request.rb', line 67

def operation_type
  @operation_type
end

#percent_complete ⇒ Float

[Required] Percentage of the request completed.

Returns:

  • (Float) 


92
93
94
 
# File 'lib/oci/datacc/models/work_request.rb', line 92

def percent_complete
  @percent_complete
end

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

[Required] The resources affected by the work request.

Returns:



84
85
86
 
# File 'lib/oci/datacc/models/work_request.rb', line 84

def resources
  @resources
end

#status ⇒ String

[Required] Status of current work request.

Returns:

  • (String) 


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

def status
  @status
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }

Returns:

  • (Hash<String, Hash<String, Object>>) 


127
128
129
 
# File 'lib/oci/datacc/models/work_request.rb', line 127

def system_tags
  @system_tags
end

#time_accepted ⇒ DateTime

[Required] The date and time that the request was created, as described in RFC 3339, section 14.29.

Returns:

  • (DateTime) 


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

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

The date and time that the request completed, as described in RFC 3339.

Returns:

  • (DateTime) 


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

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

The date and time that the request started, as described in RFC 3339, section 14.29.

Returns:

  • (DateTime) 


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

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/datacc/models/work_request.rb', line 130

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'operation_type': :'operationType',
    'status': :'status',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'resources': :'resources',
    'opc_request_id': :'opcRequestId',
    'percent_complete': :'percentComplete',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/datacc/models/work_request.rb', line 151

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'operation_type': :'String',
    'status': :'String',
    'id': :'String',
    'compartment_id': :'String',
    'resources': :'Array<OCI::Datacc::Models::WorkRequestResource>',
    'opc_request_id': :'String',
    'percent_complete': :'Float',
    'time_accepted': :'DateTime',
    'time_started': :'DateTime',
    'time_finished': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



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

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 &&
    opc_request_id == other.opc_request_id &&
    percent_complete == other.percent_complete &&
    time_accepted == other.time_accepted &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/oci/datacc/models/work_request.rb', line 338

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


318
319
320
 
# File 'lib/oci/datacc/models/work_request.rb', line 318

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



327
328
329
 
# File 'lib/oci/datacc/models/work_request.rb', line 327

def hash
  [operation_type, status, id, compartment_id, resources, opc_request_id, percent_complete, time_accepted, time_started, time_finished, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



371
372
373
374
375
376
377
378
379
380
 
# File 'lib/oci/datacc/models/work_request.rb', line 371

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



365
366
367
 
# File 'lib/oci/datacc/models/work_request.rb', line 365

def to_s
  to_hash.to_s
end