2022-01-15
▼ ▲ dataproc.projects.locations.batches.delete
HTTP Method : DELETE
Parameters :
name
Location : path
Description : Required. The name of the batch resource to delete.
Pattern : ^projects/[^/]+/locations/[^/]+/batches/[^/]+$
Type : string
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Description : Deletes the batch workload resource. If the batch is not in terminal state, the delete fails and the response returns FAILED_PRECONDITION.
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}
▼ ▲ dataproc.projects.locations.batches.get
Path : v1/{+name}
Description : Gets the batch workload resource representation.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}
Parameters :
name
Description : Required. The name of the batch to retrieve.
Pattern : ^projects/[^/]+/locations/[^/]+/batches/[^/]+$
Required : Yes
Location : path
Type : string
▼ ▲ dataproc.projects.locations.batches.list
Path : v1/{+parent}/batches
HTTP Method : GET
Description : Lists batch workloads.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/batches
Parameters :
pageToken
Description : Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.
Location : query
Type : string
parent
Location : path
Description : Required. The parent, which owns this collection of batches.
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
pageSize
Description : Optional. The maximum number of batches to return in each response. The service may return fewer than this value. The default page size is 20; the maximum page size is 1000.
Type : integer
Format : int32
Location : query
Parameter Order : parent
▼ ▲ dataproc.projects.locations.batches.create
Path : v1/{+parent}/batches
HTTP Method : POST
Parameters :
parent
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent resource where this batch will be created.
batchId
Location : query
Type : string
Description : Optional. The ID to use for the batch, which will become the final component of the batch's resource name.This value must be 4-63 characters. Valid characters are /[a-z][0-9]-/.
requestId
Type : string
Location : query
Description : Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateBatchRequest)s with the same request_id, the second request is ignored and the Operation that corresponds to the first Batch created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
Description : Creates a batch workload that executes asynchronously.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/batches
Parameter Order : parent