Class: OCI::DatabaseToolsRuntime::Models::WorkRequestSummary

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

Overview

A summary of the status of a work request.

Constant Summary collapse

OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_EXECUTE_SQL = 'EXECUTE_SQL'.freeze,
  OPERATION_TYPE_EXECUTE_SQL_SCHEDULED_DELETION = 'EXECUTE_SQL_SCHEDULED_DELETION'.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 = {}) ⇒ WorkRequestSummary

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 159

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

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

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

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

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

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

  self.created_by_principal_domain_id = attributes[:'createdByPrincipalDomainId'] if attributes[:'createdByPrincipalDomainId']

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

  self.created_by_principal_domain_id = attributes[:'created_by_principal_domain_id'] if attributes[:'created_by_principal_domain_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.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.time_scheduled = attributes[:'timeScheduled'] if attributes[:'timeScheduled']

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

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 49

def compartment_id
  @compartment_id
end

#created_by_principal_domain_id ⇒ String

Identity domain OCID for the user that submitted the asynchronous request.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 57

def created_by_principal_domain_id
  @created_by_principal_domain_id
end

#created_by_principal_id ⇒ String

Principal id of the user or resource that submitted the asynchrounous request.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 53

def created_by_principal_id
  @created_by_principal_id
end

#display_name ⇒ String

A user-friendly name for the operation. If provided for an asynchronous operation, this value will be propagated to the displayName property of the resulting Work Request, allowing for easier identification and tracking of the operation's progress and outcome. This name is purely for descriptive purposes and does not affect the functionality of the operation itself.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 33

def display_name
  @display_name
end

#id ⇒ String

[Required] The OCID of the work request.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 45

def id
  @id
end

#operation_type ⇒ String

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

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 37

def operation_type
  @operation_type
end

#percent_complete ⇒ Float

[Required] Percentage of the request completed.

Returns:

  • (Float) 


65
66
67
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 65

def percent_complete
  @percent_complete
end

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

The resources affected by this work request.

Returns:



61
62
63
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 61

def resources
  @resources
end

#status ⇒ String

[Required] The status of the work request.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 41

def status
  @status
end

#time_accepted ⇒ DateTime

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

Returns:

  • (DateTime) 


69
70
71
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 69

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) 


81
82
83
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 81

def time_finished
  @time_finished
end

#time_scheduled ⇒ DateTime

The date and time the work request is eligible to be launched, in the format defined by RFC3339.

Returns:

  • (DateTime) 


93
94
95
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 93

def time_scheduled
  @time_scheduled
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) 


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

def time_started
  @time_started
end

#time_updated ⇒ DateTime

The date and time the work request was last updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


87
88
89
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 87

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 96

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'operation_type': :'operationType',
    'status': :'status',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'created_by_principal_id': :'createdByPrincipalId',
    'created_by_principal_domain_id': :'createdByPrincipalDomainId',
    'resources': :'resources',
    'percent_complete': :'percentComplete',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'time_updated': :'timeUpdated',
    'time_scheduled': :'timeScheduled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/database_tools_runtime/models/work_request_summary.rb', line 118

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'operation_type': :'String',
    'status': :'String',
    'id': :'String',
    'compartment_id': :'String',
    'created_by_principal_id': :'String',
    'created_by_principal_domain_id': :'String',
    'resources': :'Array<OCI::DatabaseToolsRuntime::Models::WorkRequestResource>',
    'percent_complete': :'Float',
    'time_accepted': :'DateTime',
    'time_started': :'DateTime',
    'time_finished': :'DateTime',
    'time_updated': :'DateTime',
    'time_scheduled': :'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



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

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    display_name == other.display_name &&
    operation_type == other.operation_type &&
    status == other.status &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    created_by_principal_id == other.created_by_principal_id &&
    created_by_principal_domain_id == other.created_by_principal_domain_id &&
    resources == other.resources &&
    percent_complete == other.percent_complete &&
    time_accepted == other.time_accepted &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    time_updated == other.time_updated &&
    time_scheduled == other.time_scheduled
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/database_tools_runtime/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/database_tools_runtime/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/database_tools_runtime/models/work_request_summary.rb', line 303

def hash
  [display_name, operation_type, status, id, compartment_id, created_by_principal_id, created_by_principal_domain_id, resources, percent_complete, time_accepted, time_started, time_finished, time_updated, time_scheduled].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/database_tools_runtime/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/database_tools_runtime/models/work_request_summary.rb', line 341

def to_s
  to_hash.to_s
end