Class: OCI::CloudMigrations::Models::WorkRequestSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_migrations/models/work_request_summary.rb

Overview

A summary of the status of a work request.

Constant Summary collapse

OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_CREATE_MIGRATION = 'CREATE_MIGRATION'.freeze,
  OPERATION_TYPE_UPDATE_MIGRATION = 'UPDATE_MIGRATION'.freeze,
  OPERATION_TYPE_REFRESH_MIGRATION = 'REFRESH_MIGRATION'.freeze,
  OPERATION_TYPE_DELETE_MIGRATION = 'DELETE_MIGRATION'.freeze,
  OPERATION_TYPE_MOVE_MIGRATION = 'MOVE_MIGRATION'.freeze,
  OPERATION_TYPE_START_ASSET_REPLICATION = 'START_ASSET_REPLICATION'.freeze,
  OPERATION_TYPE_START_MIGRATION_REPLICATION = 'START_MIGRATION_REPLICATION'.freeze,
  OPERATION_TYPE_CREATE_REPLICATION_SCHEDULE = 'CREATE_REPLICATION_SCHEDULE'.freeze,
  OPERATION_TYPE_UPDATE_REPLICATION_SCHEDULE = 'UPDATE_REPLICATION_SCHEDULE'.freeze,
  OPERATION_TYPE_DELETE_REPLICATION_SCHEDULE = 'DELETE_REPLICATION_SCHEDULE'.freeze,
  OPERATION_TYPE_MOVE_REPLICATION_SCHEDULE = 'MOVE_REPLICATION_SCHEDULE'.freeze,
  OPERATION_TYPE_CREATE_MIGRATION_PLAN = 'CREATE_MIGRATION_PLAN'.freeze,
  OPERATION_TYPE_UPDATE_MIGRATION_PLAN = 'UPDATE_MIGRATION_PLAN'.freeze,
  OPERATION_TYPE_DELETE_MIGRATION_PLAN = 'DELETE_MIGRATION_PLAN'.freeze,
  OPERATION_TYPE_MOVE_MIGRATION_PLAN = 'MOVE_MIGRATION_PLAN'.freeze,
  OPERATION_TYPE_REFRESH_MIGRATION_PLAN = 'REFRESH_MIGRATION_PLAN'.freeze,
  OPERATION_TYPE_EXECUTE_MIGRATION_PLAN = 'EXECUTE_MIGRATION_PLAN'.freeze,
  OPERATION_TYPE_REFRESH_MIGRATION_ASSET = 'REFRESH_MIGRATION_ASSET'.freeze,
  OPERATION_TYPE_CREATE_MIGRATION_ASSET = 'CREATE_MIGRATION_ASSET'.freeze,
  OPERATION_TYPE_DELETE_MIGRATION_ASSET = 'DELETE_MIGRATION_ASSET'.freeze,
  OPERATION_TYPE_CREATE_TARGET_ASSET = 'CREATE_TARGET_ASSET'.freeze,
  OPERATION_TYPE_UPDATE_TARGET_ASSET = 'UPDATE_TARGET_ASSET'.freeze,
  OPERATION_TYPE_DELETE_TARGET_ASSET = 'DELETE_TARGET_ASSET'.freeze,
  OPERATION_TYPE_PREPARE_TARGET_ASSET = 'PREPARE_TARGET_ASSET'.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_FAILED = 'FAILED'.freeze,
  STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  STATUS_CANCELING = 'CANCELING'.freeze,
  STATUS_CANCELED = 'CANCELED'.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 = {}) ⇒ WorkRequestSummary

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::CloudMigrations::Models::WorkRequestResource>) —

    The value to assign to the #resources 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



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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 173

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

  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] The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource that is affected by the work request. If the work request affects multiple resources, and these resources are not in the same compartment, the service team can choose the primary resource of the compartment to be used.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 70

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


107
108
109
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 107

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. It exists only for cross-compatibility. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


101
102
103
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 101

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The ID of the work request.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 62

def id
  @id
end

#operation_type ⇒ String

[Required] The type of work request.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 54

def operation_type
  @operation_type
end

#percent_complete ⇒ Float

[Required] The percentage of request completed.

Returns:

  • (Float) 


78
79
80
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 78

def percent_complete
  @percent_complete
end

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

[Required] The resources affected by this work request.

Returns:



74
75
76
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 74

def resources
  @resources
end

#status ⇒ String

[Required] Status of the current work request.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 58

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


113
114
115
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 113

def system_tags
  @system_tags
end

#time_accepted ⇒ DateTime

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

Returns:

  • (DateTime) 


84
85
86
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 84

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

The date and time when the object was complete, as described in RFC 3339.

Returns:

  • (DateTime) 


95
96
97
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 95

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

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

Returns:

  • (DateTime) 


90
91
92
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 90

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 116

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',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 136

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 273

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 &&
    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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 314

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


294
295
296
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 294

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



303
304
305
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 303

def hash
  [operation_type, status, id, compartment_id, resources, 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



347
348
349
350
351
352
353
354
355
356
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 347

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



341
342
343
 
# File 'lib/oci/cloud_migrations/models/work_request_summary.rb', line 341

def to_s
  to_hash.to_s
end