Class: OCI::AiLanguage::Models::JobSummary

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

Overview

sub set of Job details data which need returns in list API

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JobSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :percent_complete (Integer) —

    The value to assign to the #percent_complete property

  • :total_documents (Integer) —

    The value to assign to the #total_documents property

  • :pending_documents (Integer) —

    The value to assign to the #pending_documents property

  • :completed_documents (Integer) —

    The value to assign to the #completed_documents property

  • :failed_documents (Integer) —

    The value to assign to the #failed_documents property

  • :warnings_count (Integer) —

    The value to assign to the #warnings_count property

  • :created_by (String) —

    The value to assign to the #created_by 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_completed (DateTime) —

    The value to assign to the #time_completed property



146
147
148
149
150
151
152
153
154
155
156
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
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
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 146

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


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

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) 


50
51
52
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 50

def completed_documents
  @completed_documents
end

#created_by ⇒ String

The OCID of the user who created the job.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 62

def created_by
  @created_by
end

#description ⇒ String

A short description of the job.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 22

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly display name for the job.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 18

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) 


54
55
56
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 54

def failed_documents
  @failed_documents
end

#id ⇒ String

[Required] The OCID of the job.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 14

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


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the Speech Job.

Returns:

  • (String) 


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

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


46
47
48
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 46

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) 


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

def percent_complete
  @percent_complete
end

#time_accepted ⇒ DateTime

Job accepted time.

Returns:

  • (DateTime) 


66
67
68
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 66

def time_accepted
  @time_accepted
end

#time_completed ⇒ DateTime

Job finished time.

Returns:

  • (DateTime) 


74
75
76
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 74

def time_completed
  @time_completed
end

#time_started ⇒ DateTime

Job started time.

Returns:

  • (DateTime) 


70
71
72
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 70

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) 


42
43
44
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 42

def total_documents
  @total_documents
end

#warnings_count ⇒ Integer

warnings count

Returns:

  • (Integer) 


58
59
60
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 58

def warnings_count
  @warnings_count
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 77

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    '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',
    'created_by': :'createdBy',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_completed': :'timeCompleted'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 101

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    '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',
    '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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 248

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    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 &&
    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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 293

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


273
274
275
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 273

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



282
283
284
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 282

def hash
  [id, display_name, description, compartment_id, lifecycle_state, lifecycle_details, percent_complete, total_documents, pending_documents, completed_documents, failed_documents, warnings_count, 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



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 326

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



320
321
322
 
# File 'lib/oci/ai_language/models/job_summary.rb', line 320

def to_s
  to_hash.to_s
end