Class: OCI::Redis::Models::WorkRequestSummary

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

Overview

A description of the work request status.

Constant Summary collapse

OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_CREATE_REDIS_CLUSTER = 'CREATE_REDIS_CLUSTER'.freeze,
  OPERATION_TYPE_UPDATE_REDIS_CLUSTER = 'UPDATE_REDIS_CLUSTER'.freeze,
  OPERATION_TYPE_DELETE_REDIS_CLUSTER = 'DELETE_REDIS_CLUSTER'.freeze,
  OPERATION_TYPE_MOVE_REDIS_CLUSTER = 'MOVE_REDIS_CLUSTER'.freeze,
  OPERATION_TYPE_FAILOVER_REDIS_CLUSTER = 'FAILOVER_REDIS_CLUSTER'.freeze,
  OPERATION_TYPE_CREATE_REDIS_CONFIG_SET = 'CREATE_REDIS_CONFIG_SET'.freeze,
  OPERATION_TYPE_UPDATE_REDIS_CONFIG_SET = 'UPDATE_REDIS_CONFIG_SET'.freeze,
  OPERATION_TYPE_DELETE_REDIS_CONFIG_SET = 'DELETE_REDIS_CONFIG_SET'.freeze,
  OPERATION_TYPE_MOVE_REDIS_CONFIG_SET = 'MOVE_REDIS_CONFIG_SET'.freeze,
  OPERATION_TYPE_MIGRATE_CLUSTER = 'MIGRATE_CLUSTER'.freeze,
  OPERATION_TYPE_CLUSTER_ROLLBACK = 'CLUSTER_ROLLBACK'.freeze,
  OPERATION_TYPE_ATTACH_OCI_CACHE_USERS = 'ATTACH_OCI_CACHE_USERS'.freeze,
  OPERATION_TYPE_DETACH_OCI_CACHE_USERS = 'DETACH_OCI_CACHE_USERS'.freeze,
  OPERATION_TYPE_CREATE_OCI_CACHE_USER = 'CREATE_OCI_CACHE_USER'.freeze,
  OPERATION_TYPE_UPDATE_OCI_CACHE_USER = 'UPDATE_OCI_CACHE_USER'.freeze,
  OPERATION_TYPE_DELETE_OCI_CACHE_USER = 'DELETE_OCI_CACHE_USER'.freeze,
  OPERATION_TYPE_CREATE_OCI_CACHE_CONFIG_SET = 'CREATE_OCI_CACHE_CONFIG_SET'.freeze,
  OPERATION_TYPE_UPDATE_OCI_CACHE_CONFIG_SET = 'UPDATE_OCI_CACHE_CONFIG_SET'.freeze,
  OPERATION_TYPE_DELETE_OCI_CACHE_CONFIG_SET = 'DELETE_OCI_CACHE_CONFIG_SET'.freeze,
  OPERATION_TYPE_CHANGE_OCI_CACHE_CONFIG_SET_COMPARTMENT = 'CHANGE_OCI_CACHE_CONFIG_SET_COMPARTMENT'.freeze,
  OPERATION_TYPE_CHANGE_OCI_CACHE_USER_COMPARTMENT = 'CHANGE_OCI_CACHE_USER_COMPARTMENT'.freeze,
  OPERATION_TYPE_CREATE_OCI_CACHE_BACKUP = 'CREATE_OCI_CACHE_BACKUP'.freeze,
  OPERATION_TYPE_UPDATE_OCI_CACHE_BACKUP = 'UPDATE_OCI_CACHE_BACKUP'.freeze,
  OPERATION_TYPE_DELETE_OCI_CACHE_BACKUP = 'DELETE_OCI_CACHE_BACKUP'.freeze,
  OPERATION_TYPE_MOVE_OCI_CACHE_BACKUP = 'MOVE_OCI_CACHE_BACKUP'.freeze,
  OPERATION_TYPE_EXPORT_OCI_CACHE_BACKUP_TO_OS = 'EXPORT_OCI_CACHE_BACKUP_TO_OS'.freeze,
  OPERATION_TYPE_PATCH_OCI_CACHE_CLUSTER = 'PATCH_OCI_CACHE_CLUSTER'.freeze,
  OPERATION_TYPE_REPLACE_OCI_CACHE_NODE = 'REPLACE_OCI_CACHE_NODE'.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_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.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 = {}) ⇒ 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::Redis::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



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
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 163

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 71

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


106
107
108
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 106

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

Returns:

  • (Hash<String, String>) 


100
101
102
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 100

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the work request.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 66

def id
  @id
end

#operation_type ⇒ String

[Required] The type of operation that spawned the work request.

Returns:

  • (String) 


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

def operation_type
  @operation_type
end

#percent_complete ⇒ Float

[Required] Percentage of the request completed.

Returns:

  • (Float) 


79
80
81
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 79

def percent_complete
  @percent_complete
end

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

[Required] The resources affected by this work request.

Returns:



75
76
77
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 75

def resources
  @resources
end

#status ⇒ String

[Required] The status of current work request.

Returns:

  • (String) 


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

def status
  @status
end

#time_accepted ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

The date and time the work request completed, in the format defined by RFC 3339.

Returns:

  • (DateTime) 


94
95
96
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 94

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

The date and time the work request was started, in the format defined by RFC 3339.

Returns:

  • (DateTime) 


89
90
91
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 89

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 109

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 128

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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 257

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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 297

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


277
278
279
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 277

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



286
287
288
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 286

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



330
331
332
333
334
335
336
337
338
339
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 330

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



324
325
326
 
# File 'lib/oci/redis/models/work_request_summary.rb', line 324

def to_s
  to_hash.to_s
end