Class: OCI::AiLanguage::Models::Job

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_language/models/job.rb

Overview

Job details which contain input document details on which prediction need to run, features (which and all language services ) need to run and where to store results

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_CANCELING = 'CANCELING'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Job

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/oci/ai_language/models/job.rb', line 195

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

  self.input_location = attributes[:'inputLocation'] if attributes[:'inputLocation']

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

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

  self.input_configuration = attributes[:'inputConfiguration'] if attributes[:'inputConfiguration']

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

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

  self.model_metadata_details = attributes[:'modelMetadataDetails'] if attributes[:'modelMetadataDetails']

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

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

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

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

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

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

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

  self.pending_documents = attributes[:'pendingDocuments'] if attributes[:'pendingDocuments']

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

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

  self.completed_documents = attributes[:'completedDocuments'] if attributes[:'completedDocuments']

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

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

  self.failed_documents = attributes[:'failedDocuments'] if attributes[:'failedDocuments']

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

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

  self.warnings_count = attributes[:'warningsCount'] if attributes[:'warningsCount']

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

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

  self.output_location = attributes[:'outputLocation'] if attributes[:'outputLocation']

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

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

  self.ttl_in_days = attributes[:'ttlInDays'] if attributes[:'ttlInDays']

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

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

  self.created_by = attributes[:'createdBy'] if attributes[:'createdBy']

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

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

  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_completed = attributes[:'timeCompleted'] if attributes[:'timeCompleted']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment where you want to create the job.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/ai_language/models/job.rb', line 52

def compartment_id
  @compartment_id
end

#completed_documents ⇒ Integer

Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.

Returns:

  • (Integer) 


76
77
78
 
# File 'lib/oci/ai_language/models/job.rb', line 76

def completed_documents
  @completed_documents
end

#created_by ⇒ String

The OCID of the user who created the job.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/ai_language/models/job.rb', line 96

def created_by
  @created_by
end

#description ⇒ String

A short description of the job.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/ai_language/models/job.rb', line 34

def description
  @description
end

#display_name ⇒ String

A user-friendly display name for the job.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/ai_language/models/job.rb', line 30

def display_name
  @display_name
end

#failed_documents ⇒ Integer

Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.

Returns:

  • (Integer) 


80
81
82
 
# File 'lib/oci/ai_language/models/job.rb', line 80

def failed_documents
  @failed_documents
end

#id ⇒ String

[Required] The OCID of the job.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/ai_language/models/job.rb', line 26

def id
  @id
end

#input_configuration ⇒ OCI::AiLanguage::Models::InputConfiguration

Returns:



41
42
43
 
# File 'lib/oci/ai_language/models/job.rb', line 41

def input_configuration
  @input_configuration
end

#input_location ⇒ OCI::AiLanguage::Models::InputLocation

This attribute is required.

Returns:



38
39
40
 
# File 'lib/oci/ai_language/models/job.rb', line 38

def input_location
  @input_location
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/ai_language/models/job.rb', line 60

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the Job.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/ai_language/models/job.rb', line 56

def lifecycle_state
  @lifecycle_state
end

#model_metadata_details ⇒ Array<OCI::AiLanguage::Models::ModelMetadataDetails>

[Required] training model details For this release only one model is allowed to be input here. One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API

Returns:



48
49
50
 
# File 'lib/oci/ai_language/models/job.rb', line 48

def model_metadata_details
  @model_metadata_details
end

#output_location ⇒ OCI::AiLanguage::Models::ObjectPrefixOutputLocation

This attribute is required.

Returns:



88
89
90
 
# File 'lib/oci/ai_language/models/job.rb', line 88

def output_location
  @output_location
end

#pending_documents ⇒ Integer

Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.

Returns:

  • (Integer) 


72
73
74
 
# File 'lib/oci/ai_language/models/job.rb', line 72

def pending_documents
  @pending_documents
end

#percent_complete ⇒ Integer

How much progress the operation has made, vs the total amount of work that must be performed.

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/oci/ai_language/models/job.rb', line 64

def percent_complete
  @percent_complete
end

#time_accepted ⇒ DateTime

Job accepted time.

Returns:

  • (DateTime) 


100
101
102
 
# File 'lib/oci/ai_language/models/job.rb', line 100

def time_accepted
  @time_accepted
end

#time_completed ⇒ DateTime

Job finished time.

Returns:

  • (DateTime) 


108
109
110
 
# File 'lib/oci/ai_language/models/job.rb', line 108

def time_completed
  @time_completed
end

#time_started ⇒ DateTime

Job started time.

Returns:

  • (DateTime) 


104
105
106
 
# File 'lib/oci/ai_language/models/job.rb', line 104

def time_started
  @time_started
end

#total_documents ⇒ Integer

Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.

Returns:

  • (Integer) 


68
69
70
 
# File 'lib/oci/ai_language/models/job.rb', line 68

def total_documents
  @total_documents
end

#ttl_in_days ⇒ Integer

Time to live duration in days for Job. Job will be available till max 90 days.

Returns:

  • (Integer) 


92
93
94
 
# File 'lib/oci/ai_language/models/job.rb', line 92

def ttl_in_days
  @ttl_in_days
end

#warnings_count ⇒ Integer

warnings count

Returns:

  • (Integer) 


84
85
86
 
# File 'lib/oci/ai_language/models/job.rb', line 84

def warnings_count
  @warnings_count
end

Class Method Details

.attribute_map ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/ai_language/models/job.rb', line 111

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'input_location': :'inputLocation',
    'input_configuration': :'inputConfiguration',
    'model_metadata_details': :'modelMetadataDetails',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'percent_complete': :'percentComplete',
    'total_documents': :'totalDocuments',
    'pending_documents': :'pendingDocuments',
    'completed_documents': :'completedDocuments',
    'failed_documents': :'failedDocuments',
    'warnings_count': :'warningsCount',
    'output_location': :'outputLocation',
    'ttl_in_days': :'ttlInDays',
    'created_by': :'createdBy',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_completed': :'timeCompleted'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/ai_language/models/job.rb', line 140

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'input_location': :'OCI::AiLanguage::Models::InputLocation',
    'input_configuration': :'OCI::AiLanguage::Models::InputConfiguration',
    'model_metadata_details': :'Array<OCI::AiLanguage::Models::ModelMetadataDetails>',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'percent_complete': :'Integer',
    'total_documents': :'Integer',
    'pending_documents': :'Integer',
    'completed_documents': :'Integer',
    'failed_documents': :'Integer',
    'warnings_count': :'Integer',
    'output_location': :'OCI::AiLanguage::Models::ObjectPrefixOutputLocation',
    'ttl_in_days': :'Integer',
    'created_by': :'String',
    'time_accepted': :'DateTime',
    'time_started': :'DateTime',
    'time_completed': :'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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/oci/ai_language/models/job.rb', line 340

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    input_location == other.input_location &&
    input_configuration == other.input_configuration &&
    model_metadata_details == other.model_metadata_details &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    percent_complete == other.percent_complete &&
    total_documents == other.total_documents &&
    pending_documents == other.pending_documents &&
    completed_documents == other.completed_documents &&
    failed_documents == other.failed_documents &&
    warnings_count == other.warnings_count &&
    output_location == other.output_location &&
    ttl_in_days == other.ttl_in_days &&
    created_by == other.created_by &&
    time_accepted == other.time_accepted &&
    time_started == other.time_started &&
    time_completed == other.time_completed
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



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/oci/ai_language/models/job.rb', line 390

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


370
371
372
 
# File 'lib/oci/ai_language/models/job.rb', line 370

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



379
380
381
 
# File 'lib/oci/ai_language/models/job.rb', line 379

def hash
  [id, display_name, description, input_location, input_configuration, model_metadata_details, compartment_id, lifecycle_state, lifecycle_details, percent_complete, total_documents, pending_documents, completed_documents, failed_documents, warnings_count, output_location, ttl_in_days, created_by, time_accepted, time_started, time_completed].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



423
424
425
426
427
428
429
430
431
432
 
# File 'lib/oci/ai_language/models/job.rb', line 423

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



417
418
419
 
# File 'lib/oci/ai_language/models/job.rb', line 417

def to_s
  to_hash.to_s
end