| id |
String |
When your application sends a job request to Modigie, it must publish the message with the Pub/Sub attribute `modigieJobRequestId` with an ID that is unique for the repository to which your application is connected. This also works as an idempotency key to prevent accidental duplicates. On success, this value becomes the job's `id` and part of the job's unique identifer `name`. Your application should store the request ID to avoid sending later a different payload with the same ID. If your job request gets discarded, the repository will not create a job and therefore the job response message will not include an `id` or `name` property. |
[optional] [default to null] |
| name |
String |
Relative resource name of a job resource (`path-noscheme`), assigned by system when it is created. Important: This value is only unique within the Modigie integration used by your application. For a globally unique value, see the job's `dnsName`. |
[optional] [default to null] |
| jobType |
String |
Type of the job. Every job may perform more than one tasks. While the schema is identical between all job types, they differ in which fields are required in requests and which fields will be populated in responses. Please note, that not all job types are available in all integrations. Some job types depend on the subscription and configuration of the repository that is connected to your application. |
[optional] [default to null] |
| createTime |
Date |
Timestamp when this job was created in the Modigie pipeline. |
[optional] [default to null] |
| updateTime |
Date |
Timestamp when this job was last modified in the Modigie pipeline. If you receive multiple job response messages for the same job, your application can use the `updateTime` to determine which message reflects the latest state of the job. |
[optional] [default to null] |
| deleteTime |
JobV2_deleteTime |
|
[optional] [default to null] |
| purgeTime |
JobV2_purgeTime |
|
[optional] [default to null] |
| expireTime |
JobV2_expireTime |
|
[optional] [default to null] |
| dispatchTime |
JobV2_dispatchTime |
|
[optional] [default to null] |
| startTime |
JobV2_startTime |
|
[optional] [default to null] |
| endTime |
JobV2_endTime |
|
[optional] [default to null] |
| reason |
JobV2_reason |
|
[optional] [default to null] |
| status |
String |
The current status of this job represents where the job is in its life cycle. Please note that your application should only digest information from a job into your database if the job's `status = \"completed\"`. Intermediate states are any states the job will transition away from during its life cycle: * `\"created\"` This is the initial status of a job if your request is accepted and `modigieJobRequestId` is a unique ID that was not used before. If the `modigieJobRequestId` value is missing, invalid, or has been used earlier with a different `payload`, the job request will be discarded before entering our system. * `\"validated\"`: The job passed the advanced request validation. * `\"enqueued\"`: The job waits in the pipeline for processing. The time it waits in the queue depends on many factors, including the available quota for your application and the current utilization of the real-time engine. * `\"dispatching\"`: This job is due to be processed immediately. * `\"processing\"`: The processing of the job has started in the real-time engine. Terminal states are any final states a job will transition into at the end of its life cycle: * `\"rejected\"`: The job cannot be processed because it failed the request validation. Details can be found in the job's `reason` property. Your application SHOULD NOT retry the request without modifying the payload and using a new `modigieJobRequestId`! * `\"canceled\"`: The job has been canceled. Details can be found in the job's `reason` property. Your application CAN safely retry the payload with a new `modigieJobRequestId`. * `\"failed\"`: The job failed during processing. Details can be found in the job's `reason` property. Typically, this occurs due to temporary technical reasons. Your application CAN safely retry the payload with a new `modigieJobRequestId`. * `\"completed\"`: The job completed successfully in the real-time engine, and your application can safely process the information received with the job message. Your application should interpret the event codes in the job's `events` field. Note: Modigie charges only for jobs that arrive at the status `completed`! |
[optional] [default to null] |
| events |
JobV2_events |
|
[optional] [default to null] |
| repository |
Pipeline_repository |
|
[optional] [default to null] |
| payload |
JobV2_payload |
|
[optional] [default to null] |
| priority |
Integer |
Priority of the job. Jobs with a greater `priority` value are processed before any jobs with a lower `priority`, even if the job with the higher `priority` value was requested after a lower `priority` job or would expire after it. |
[optional] [default to 50] |