Sign in

v1

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

Creates a batch job.

post/v1/{+parent}/jobs

Path parameters

parentstring required

Required. The value for parent.

Query parameters

jobIdstring

Required. A unique identifier for the job. job_id must be up to 128 characters and must include only characters available in DNS names, as defined by RFC-1123.

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same request_id are ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID isn't supported (00000000-0000-0000-0000-000000000000).

Request body

dryRunboolean

Optional. If true, the job runs in dry run mode, returning the total object count and, if the object configuration is a prefix list, the bytes found from source. No transformations are performed.

state'STATE_UNSPECIFIED' | 'RUNNING' | 'SUCCEEDED' | 'CANCELED' | 'FAILED' | 'QUEUED'

Output only. State of the job.

createTimestring google-datetime

Output only. The time that the job was created.

isMultiBucketJobboolean

Output only. If true, this job operates on multiple buckets. Multi-bucket jobs are subject to different quota limits than single-bucket jobs.

namestring

Identifier. The resource name of the job. Format: projects/{project_id}/locations/global/jobs/{job_id}. For example: projects/123456/locations/global/jobs/job01. job_id is unique in a given project.

scheduleTimestring google-datetime

Output only. The time that the job was scheduled.

completeTimestring google-datetime

Output only. The time that the job was completed.

descriptionstring

Optional. A user-provided description for the job. Maximum length: 1024 bytes when unicode-encoded.

Response

Successful response