Class: OCI::Ocvp::Models::WorkRequest

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

Overview

An asynchronous work request.

Constant Summary collapse

OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_CREATE_SDDC = 'CREATE_SDDC'.freeze,
  OPERATION_TYPE_DELETE_SDDC = 'DELETE_SDDC'.freeze,
  OPERATION_TYPE_CREATE_CLUSTER = 'CREATE_CLUSTER'.freeze,
  OPERATION_TYPE_DELETE_CLUSTER = 'DELETE_CLUSTER'.freeze,
  OPERATION_TYPE_CREATE_ESXI_HOST = 'CREATE_ESXI_HOST'.freeze,
  OPERATION_TYPE_DELETE_ESXI_HOST = 'DELETE_ESXI_HOST'.freeze,
  OPERATION_TYPE_UPGRADE_HCX = 'UPGRADE_HCX'.freeze,
  OPERATION_TYPE_DOWNGRADE_HCX = 'DOWNGRADE_HCX'.freeze,
  OPERATION_TYPE_CANCEL_DOWNGRADE_HCX = 'CANCEL_DOWNGRADE_HCX'.freeze,
  OPERATION_TYPE_REFRESH_HCX_LICENSE_STATUS = 'REFRESH_HCX_LICENSE_STATUS'.freeze,
  OPERATION_TYPE_SWAP_BILLING = 'SWAP_BILLING'.freeze,
  OPERATION_TYPE_REPLACE_HOST = 'REPLACE_HOST'.freeze,
  OPERATION_TYPE_IN_PLACE_UPGRADE = 'IN_PLACE_UPGRADE'.freeze,
  OPERATION_TYPE_CREATE_DATASTORE = 'CREATE_DATASTORE'.freeze,
  OPERATION_TYPE_UPDATE_DATASTORE = 'UPDATE_DATASTORE'.freeze,
  OPERATION_TYPE_ADD_BLOCK_VOLUME_TO_DATASTORE = 'ADD_BLOCK_VOLUME_TO_DATASTORE'.freeze,
  OPERATION_TYPE_DELETE_DATASTORE = 'DELETE_DATASTORE'.freeze,
  OPERATION_TYPE_CREATE_DATASTORE_CLUSTER = 'CREATE_DATASTORE_CLUSTER'.freeze,
  OPERATION_TYPE_UPDATE_DATASTORE_CLUSTER = 'UPDATE_DATASTORE_CLUSTER'.freeze,
  OPERATION_TYPE_ATTACH_DATASTORE_CLUSTER_TO_ESXI_HOST = 'ATTACH_DATASTORE_CLUSTER_TO_ESXI_HOST'.freeze,
  OPERATION_TYPE_ATTACH_DATASTORE_CLUSTER_TO_CLUSTER = 'ATTACH_DATASTORE_CLUSTER_TO_CLUSTER'.freeze,
  OPERATION_TYPE_DETACH_DATASTORE_CLUSTER_FROM_ESXI_HOST = 'DETACH_DATASTORE_CLUSTER_FROM_ESXI_HOST'.freeze,
  OPERATION_TYPE_DETACH_DATASTORE_CLUSTER_FROM_CLUSTER = 'DETACH_DATASTORE_CLUSTER_FROM_CLUSTER'.freeze,
  OPERATION_TYPE_DELETE_DATASTORE_CLUSTER = 'DELETE_DATASTORE_CLUSTER'.freeze,
  OPERATION_TYPE_ADD_DATASTORE_TO_DATASTORE_CLUSTER = 'ADD_DATASTORE_TO_DATASTORE_CLUSTER'.freeze,
  OPERATION_TYPE_REMOVE_DATASTORE_FROM_DATASTORE_CLUSTER = 'REMOVE_DATASTORE_FROM_DATASTORE_CLUSTER'.freeze,
  OPERATION_TYPE_CREATE_MANAGEMENT_APPLIANCE = 'CREATE_MANAGEMENT_APPLIANCE'.freeze,
  OPERATION_TYPE_UPDATE_MANAGEMENT_APPLIANCE = 'UPDATE_MANAGEMENT_APPLIANCE'.freeze,
  OPERATION_TYPE_DELETE_MANAGEMENT_APPLIANCE = 'DELETE_MANAGEMENT_APPLIANCE'.freeze,
  OPERATION_TYPE_ABANDON_MANAGEMENT_APPLIANCE_JOBS = 'ABANDON_MANAGEMENT_APPLIANCE_JOBS'.freeze,
  OPERATION_TYPE_BATCH_DELETE_MANAGEMENT_APPLIANCE_JOBS = 'BATCH_DELETE_MANAGEMENT_APPLIANCE_JOBS'.freeze,
  OPERATION_TYPE_MANAGEMENT_APPLIANCE_ESXI_HOST_PROVISIONING = 'MANAGEMENT_APPLIANCE_ESXI_HOST_PROVISIONING'.freeze,
  OPERATION_TYPE_MANAGEMENT_APPLIANCE_ESXI_HOST_DELETION = 'MANAGEMENT_APPLIANCE_ESXI_HOST_DELETION'.freeze,
  OPERATION_TYPE_MANAGEMENT_APPLIANCE_DATASTORE_PROVISIONING = 'MANAGEMENT_APPLIANCE_DATASTORE_PROVISIONING'.freeze,
  OPERATION_TYPE_MANAGEMENT_APPLIANCE_DATASTORE_DELETE = 'MANAGEMENT_APPLIANCE_DATASTORE_DELETE'.freeze,
  OPERATION_TYPE_CREATE_BYOL = 'CREATE_BYOL'.freeze,
  OPERATION_TYPE_UPDATE_BYOL = 'UPDATE_BYOL'.freeze,
  OPERATION_TYPE_DELETE_BYOL = 'DELETE_BYOL'.freeze,
  OPERATION_TYPE_CREATE_BYOL_ALLOCATION = 'CREATE_BYOL_ALLOCATION'.freeze,
  OPERATION_TYPE_UPDATE_BYOL_ALLOCATION = 'UPDATE_BYOL_ALLOCATION'.freeze,
  OPERATION_TYPE_DELETE_BYOL_ALLOCATION = 'DELETE_BYOL_ALLOCATION'.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

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



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
207
208
209
 
# File 'lib/oci/ocvp/models/work_request.rb', line 162

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.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#id ⇒ String

[Required] The OCID of the work request.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/ocvp/models/work_request.rb', line 77

def id
  @id
end

#operation_type ⇒ String

[Required] The asynchronous operation tracked by this work request.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/ocvp/models/work_request.rb', line 69

def operation_type
  @operation_type
end

#percent_complete ⇒ Float

[Required] The percentage complete of the operation tracked by this work request.

Returns:

  • (Float) 


91
92
93
 
# File 'lib/oci/ocvp/models/work_request.rb', line 91

def percent_complete
  @percent_complete
end

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

[Required] The resources that are affected by this work request.

Returns:



87
88
89
 
# File 'lib/oci/ocvp/models/work_request.rb', line 87

def resources
  @resources
end

#status ⇒ String

[Required] The status of the work request.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/ocvp/models/work_request.rb', line 73

def status
  @status
end

#time_accepted ⇒ DateTime

[Required] The date and time the work request was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


99
100
101
 
# File 'lib/oci/ocvp/models/work_request.rb', line 99

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

The date and time the work request reached a terminal state, either FAILED OR SUCCEEDED. Format is defined by RFC3339.

Returns:

  • (DateTime) 


111
112
113
 
# File 'lib/oci/ocvp/models/work_request.rb', line 111

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by RFC3339.

Returns:

  • (DateTime) 


105
106
107
 
# File 'lib/oci/ocvp/models/work_request.rb', line 105

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/ocvp/models/work_request.rb', line 114

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.



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

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/ocvp/models/work_request.rb', line 244

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/oci/ocvp/models/work_request.rb', line 282

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


262
263
264
 
# File 'lib/oci/ocvp/models/work_request.rb', line 262

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



271
272
273
 
# File 'lib/oci/ocvp/models/work_request.rb', line 271

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



315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/ocvp/models/work_request.rb', line 315

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



309
310
311
 
# File 'lib/oci/ocvp/models/work_request.rb', line 309

def to_s
  to_hash.to_s
end