ConsumerJob

ConsumerJob
ConsumerJob

The information required to create a data job, including the definition of the job itself, the owner of the job, and callback URIs so that the DMS may inform the consumer of status and job results.

JSON Example
{
    "info_type_id": "pmhistory",
    "job_result_uri": "http://pmhistory-consumer:8000/v0alpha1/jobs/53196a4b-6b1b-4284-9213-dd8f36d88537",
    "job_owner": "pmhistory-consumer",
    "status_notification_uri": "http://pmhistory-consumer:8000/v0alpha1/jobs/53196a4b-6b1b-4284-9213-dd8f36d88537/status"
}
string
info_type_id
Required

The identifier of the data type that this job is consuming.

string
job_result_uri
Required

The target URI to which the DMS will post job results when they are ready.

string
job_owner
Required

The identifier of the owner of the job. Generally this is the consumer itself.

object
job_definition
Required

A job definition matching the schema associated with the chosen data type.

string
status_notification_uri
Optional

An optional notification URI to which the DMS may post status updates if the job goes from an enabled to disabled state, or vice versa.