Package com.ibm.watson.speech_to_text.v1.model

Class RecognitionJob

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.speech_to_text.v1.model.RecognitionJob

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class RecognitionJob
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Information about a current asynchronous speech recognition job.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RecognitionJob.Status	The current status of the job: * `waiting`: The service is preparing the job for processing.

Constructor Summary

Constructors

Constructor	Description
RecognitionJob()

Method Summary

Modifier and Type	Method	Description
String	getCreated()	Gets the created.
String	getId()	Gets the id.
List<SpeechRecognitionResults>	getResults()	Gets the results.
String	getStatus()	Gets the status.
String	getUpdated()	Gets the updated.
String	getUrl()	Gets the url.
String	getUserToken()	Gets the userToken.
List<String>	getWarnings()	Gets the warnings.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RecognitionJob

public RecognitionJob()

Method Details

getId

public String getId()

Gets the id.

The ID of the asynchronous job.

Returns:

the id

getStatus

public String getStatus()

Gets the status.

The current status of the job: * `waiting`: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it. * `processing`: The service is actively processing the job. * `completed`: The service has finished processing the job. If the job specified a callback URL and the event `recognitions.completed_with_results`, the service sent the results with the callback notification. Otherwise, you must retrieve the results by checking the individual job. * `failed`: The job failed.

Returns:

the status

getCreated

public String getCreated()

Gets the created.

The date and time in Coordinated Universal Time (UTC) at which the job was created. The value is provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`).

Returns:

the created

getUpdated

public String getUpdated()

Gets the updated.

The date and time in Coordinated Universal Time (UTC) at which the job was last updated by the service. The value is provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`). This field is returned only by the **Check jobs** and **Check a job** methods.

Returns:

the updated

getUrl

public String getUrl()

Gets the url.

The URL to use to request information about the job with the **Check a job** method. This field is returned only by the **Create a job** method.

Returns:

the url

getUserToken

public String getUserToken()

Gets the userToken.

The user token associated with a job that was created with a callback URL and a user token. This field can be returned only by the **Check jobs** method.

Returns:

the userToken

getResults

public List<SpeechRecognitionResults> getResults()

Gets the results.

If the status is `completed`, the results of the recognition request as an array that includes a single instance of a `SpeechRecognitionResults` object. This field is returned only by the **Check a job** method.

Returns:

the results

getWarnings

public List<String> getWarnings()

Gets the warnings.

An array of warning messages about invalid parameters included with the request. Each warning includes a descriptive message and a list of invalid argument strings, for example, `"unexpected query parameter 'user_token', query parameter 'callback_url' was not specified"`. The request succeeds despite the warnings. This field can be returned only by the **Create a job** method.

Returns:

the warnings