Class: OCI::DataScience::Models::WorkRequest

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

Overview

An asynchronous work request.

Constant Summary collapse

OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_NOTEBOOK_SESSION_CREATE = 'NOTEBOOK_SESSION_CREATE'.freeze,
  OPERATION_TYPE_NOTEBOOK_SESSION_DELETE = 'NOTEBOOK_SESSION_DELETE'.freeze,
  OPERATION_TYPE_NOTEBOOK_SESSION_ACTIVATE = 'NOTEBOOK_SESSION_ACTIVATE'.freeze,
  OPERATION_TYPE_NOTEBOOK_SESSION_DEACTIVATE = 'NOTEBOOK_SESSION_DEACTIVATE'.freeze,
  OPERATION_TYPE_MODELVERSIONSET_DELETE = 'MODELVERSIONSET_DELETE'.freeze,
  OPERATION_TYPE_EXPORT_MODEL_ARTIFACT = 'EXPORT_MODEL_ARTIFACT'.freeze,
  OPERATION_TYPE_IMPORT_MODEL_ARTIFACT = 'IMPORT_MODEL_ARTIFACT'.freeze,
  OPERATION_TYPE_MODEL_DEPLOYMENT_CREATE = 'MODEL_DEPLOYMENT_CREATE'.freeze,
  OPERATION_TYPE_MODEL_DEPLOYMENT_DELETE = 'MODEL_DEPLOYMENT_DELETE'.freeze,
  OPERATION_TYPE_MODEL_DEPLOYMENT_ACTIVATE = 'MODEL_DEPLOYMENT_ACTIVATE'.freeze,
  OPERATION_TYPE_MODEL_DEPLOYMENT_DEACTIVATE = 'MODEL_DEPLOYMENT_DEACTIVATE'.freeze,
  OPERATION_TYPE_MODEL_DEPLOYMENT_UPDATE = 'MODEL_DEPLOYMENT_UPDATE'.freeze,
  OPERATION_TYPE_PROJECT_DELETE = 'PROJECT_DELETE'.freeze,
  OPERATION_TYPE_WORKREQUEST_CANCEL = 'WORKREQUEST_CANCEL'.freeze,
  OPERATION_TYPE_JOB_DELETE = 'JOB_DELETE'.freeze,
  OPERATION_TYPE_PIPELINE_CREATE = 'PIPELINE_CREATE'.freeze,
  OPERATION_TYPE_PIPELINE_DELETE = 'PIPELINE_DELETE'.freeze,
  OPERATION_TYPE_PIPELINE_RUN_CREATE = 'PIPELINE_RUN_CREATE'.freeze,
  OPERATION_TYPE_PIPELINE_RUN_CANCEL = 'PIPELINE_RUN_CANCEL'.freeze,
  OPERATION_TYPE_PIPELINE_RUN_DELETE = 'PIPELINE_RUN_DELETE'.freeze,
  OPERATION_TYPE_ML_APPLICATION_PACKAGE_UPLOAD = 'ML_APPLICATION_PACKAGE_UPLOAD'.freeze,
  OPERATION_TYPE_ML_APPLICATION_TRIGGER_START = 'ML_APPLICATION_TRIGGER_START'.freeze,
  OPERATION_TYPE_ML_APPLICATION_IMPLEMENTATION_DELETE = 'ML_APPLICATION_IMPLEMENTATION_DELETE'.freeze,
  OPERATION_TYPE_ML_APPLICATION_IMPLEMENTATION_UPDATE = 'ML_APPLICATION_IMPLEMENTATION_UPDATE'.freeze,
  OPERATION_TYPE_ML_APPLICATION_IMPLEMENTATION_MOVE = 'ML_APPLICATION_IMPLEMENTATION_MOVE'.freeze,
  OPERATION_TYPE_ML_APPLICATION_INSTANCE_CREATE = 'ML_APPLICATION_INSTANCE_CREATE'.freeze,
  OPERATION_TYPE_ML_APPLICATION_INSTANCE_UPDATE = 'ML_APPLICATION_INSTANCE_UPDATE'.freeze,
  OPERATION_TYPE_ML_APPLICATION_INSTANCE_DELETE = 'ML_APPLICATION_INSTANCE_DELETE'.freeze,
  OPERATION_TYPE_ML_APPLICATION_INSTANCE_MOVE = 'ML_APPLICATION_INSTANCE_MOVE'.freeze,
  OPERATION_TYPE_ML_APPLICATION_INSTANCE_VIEW_CREATE = 'ML_APPLICATION_INSTANCE_VIEW_CREATE'.freeze,
  OPERATION_TYPE_ML_APPLICATION_INSTANCE_VIEW_UPDATE = 'ML_APPLICATION_INSTANCE_VIEW_UPDATE'.freeze,
  OPERATION_TYPE_ML_APPLICATION_INSTANCE_VIEW_DELETE = 'ML_APPLICATION_INSTANCE_VIEW_DELETE'.freeze,
  OPERATION_TYPE_ML_APPLICATION_INSTANCE_VIEW_UPGRADE = 'ML_APPLICATION_INSTANCE_VIEW_UPGRADE'.freeze,
  OPERATION_TYPE_ML_APPLICATION_INSTANCE_VIEW_MOVE = 'ML_APPLICATION_INSTANCE_VIEW_MOVE'.freeze,
  OPERATION_TYPE_PRIVATE_ENDPOINT_CREATE = 'PRIVATE_ENDPOINT_CREATE'.freeze,
  OPERATION_TYPE_PRIVATE_ENDPOINT_DELETE = 'PRIVATE_ENDPOINT_DELETE'.freeze,
  OPERATION_TYPE_PRIVATE_ENDPOINT_MOVE = 'PRIVATE_ENDPOINT_MOVE'.freeze,
  OPERATION_TYPE_PRIVATE_ENDPOINT_UPDATE = 'PRIVATE_ENDPOINT_UPDATE'.freeze,
  OPERATION_TYPE_SCHEDULE_CREATE = 'SCHEDULE_CREATE'.freeze,
  OPERATION_TYPE_SCHEDULE_UPDATE = 'SCHEDULE_UPDATE'.freeze,
  OPERATION_TYPE_SCHEDULE_DELETE = 'SCHEDULE_DELETE'.freeze,
  OPERATION_TYPE_SCHEDULE_MOVE = 'SCHEDULE_MOVE'.freeze,
  OPERATION_TYPE_SCHEDULE_ACTIVATE = 'SCHEDULE_ACTIVATE'.freeze,
  OPERATION_TYPE_SCHEDULE_DEACTIVATE = 'SCHEDULE_DEACTIVATE'.freeze,
  OPERATION_TYPE_REGISTER_MODEL_ARTIFACT = 'REGISTER_MODEL_ARTIFACT'.freeze,
  OPERATION_TYPE_RESTORE_ARCHIVED_MODEL = 'RESTORE_ARCHIVED_MODEL'.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):



157
158
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
 
# File 'lib/oci/data_science/models/work_request.rb', line 157

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

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

  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 work request's compartment.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/data_science/models/work_request.rb', line 86

def compartment_id
  @compartment_id
end

#id ⇒ String

[Required] The OCID of the work request.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/data_science/models/work_request.rb', line 74

def id
  @id
end

#operation_type ⇒ String

[Required] The type of work the work request is doing.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/data_science/models/work_request.rb', line 78

def operation_type
  @operation_type
end

#percent_complete ⇒ Float

[Required] Percentage of the request completed.

Returns:

  • (Float) 


90
91
92
 
# File 'lib/oci/data_science/models/work_request.rb', line 90

def percent_complete
  @percent_complete
end

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

[Required] The resources affected by this work request.

Returns:



94
95
96
 
# File 'lib/oci/data_science/models/work_request.rb', line 94

def resources
  @resources
end

#status ⇒ String

[Required] The current status of the work request.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/data_science/models/work_request.rb', line 82

def status
  @status
end

#time_accepted ⇒ DateTime

[Required] The time the work request was accepted in the timestamp format defined by RFC3339.

Returns:

  • (DateTime) 


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

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

The time the work request was finished in the timestamp format defined by RFC3339.

Returns:

  • (DateTime) 


106
107
108
 
# File 'lib/oci/data_science/models/work_request.rb', line 106

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

The time the work request was started in the timestamp format defined by RFC3339.

Returns:

  • (DateTime) 


102
103
104
 
# File 'lib/oci/data_science/models/work_request.rb', line 102

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
 
# File 'lib/oci/data_science/models/work_request.rb', line 109

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

.swagger_types ⇒ Object

Attribute type mapping.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/data_science/models/work_request.rb', line 126

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/data_science/models/work_request.rb', line 239

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

  self.class == other.class &&
    id == other.id &&
    operation_type == other.operation_type &&
    status == other.status &&
    compartment_id == other.compartment_id &&
    percent_complete == other.percent_complete &&
    resources == other.resources &&
    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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/data_science/models/work_request.rb', line 277

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


257
258
259
 
# File 'lib/oci/data_science/models/work_request.rb', line 257

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# File 'lib/oci/data_science/models/work_request.rb', line 266

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



310
311
312
313
314
315
316
317
318
319
 
# File 'lib/oci/data_science/models/work_request.rb', line 310

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



304
305
306
 
# File 'lib/oci/data_science/models/work_request.rb', line 304

def to_s
  to_hash.to_s
end