Interface CreateJobOptions.Events
- Enclosing class:
- CreateJobOptions
public static interface CreateJobOptions.Events
If the job includes a callback URL, a comma-separated list of notification events to which to
subscribe. Valid events are * `recognitions.started` generates a callback notification when the
service begins to process the job. * `recognitions.completed` generates a callback notification
when the job is complete. You must use the [Check a job](#checkjob) method to retrieve the
results before they time out or are deleted. * `recognitions.completed_with_results` generates
a callback notification when the job is complete. The notification includes the results of the
request. * `recognitions.failed` generates a callback notification if the service experiences
an error while processing the job.
The `recognitions.completed` and `recognitions.completed_with_results` events are incompatible. You can specify only of the two events.
If the job includes a callback URL, omit the parameter to subscribe to the default events: `recognitions.started`, `recognitions.completed`, and `recognitions.failed`. If the job does not include a callback URL, omit the parameter.
-
Field Summary
Fields Modifier and Type Field Description static String
RECOGNITIONS_COMPLETED
recognitions.completed.static String
RECOGNITIONS_COMPLETED_WITH_RESULTS
recognitions.completed_with_results.static String
RECOGNITIONS_FAILED
recognitions.failed.static String
RECOGNITIONS_STARTED
recognitions.started.
-
Field Details
-
RECOGNITIONS_STARTED
recognitions.started.- See Also:
- Constant Field Values
-
RECOGNITIONS_COMPLETED
recognitions.completed.- See Also:
- Constant Field Values
-
RECOGNITIONS_COMPLETED_WITH_RESULTS
recognitions.completed_with_results.- See Also:
- Constant Field Values
-
RECOGNITIONS_FAILED
recognitions.failed.- See Also:
- Constant Field Values
-