Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132986146.6 KB
projects

Creates a training or a batch prediction job.

post/v1/{+parent}/jobs

Path parameters

parentstring required

Required. The project name.

Request body

jobPositionstring int64

Output only. It's only effect when the job is in QUEUED state. If it's positive, it indicates the job's position in the job scheduler. It's 0 when the job is already scheduled.

createTimestring google-datetime

Output only. When the job was created.

startTimestring google-datetime

Output only. When the job processing was started.

labelsobject

Optional. One or more labels that you can add, to organize your jobs. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels.

endTimestring google-datetime

Output only. When the job processing was completed.

state'STATE_UNSPECIFIED' | 'QUEUED' | 'PREPARING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'CANCELLING' | 'CANCELLED'

Output only. The detailed state of a job.

etagstring byte

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform job updates in order to avoid race conditions: An etag is returned in the response to GetJob, and systems are expected to put that etag in the request to UpdateJob to ensure that their change will be applied to the same version of the job.

errorMessagestring

Output only. The details of a failure or a cancellation.

jobIdstring

Required. The user-specified id of the job.

Response

Successful response