v1

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

Create a Job.

post/v1/{+parent}/jobs

Path parameters

parentstring required

Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}"

Query parameters

jobIdstring

ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and '-' are accepted. The '-' character cannot be the first or the last one. A system generated ID will be used if the field is not set. The job.name field in the request will be ignored and the created resource name of the Job will be "{parent}/jobs/{job_id}".

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

createTimestring google-datetime

Output only. When the Job was created.

namestring

Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".

uidstring

Output only. A system generated unique ID for the Job.

prioritystring int64

Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.

updateTimestring google-datetime

Output only. The last time the Job was updated.

labelsobject

Custom labels to apply to the job and any Cloud Logging LogEntry that it generates. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple labels fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see Organize resources using labels.

Response

Successful response