2022-01-14
▼ ▲ dataproc.projects.locations.batches.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Description: Required. The name of the batch resource to delete.
Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+$
Required: Yes
Location: path
Type: string
Description: Deletes the batch workload resource. If the batch is not in terminal state, the delete fails and the response returns FAILED_PRECONDITION.
HTTP Method: DELETE
▼ ▲ dataproc.projects.locations.batches.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1/{+parent}/batches
Parameters:
pageToken
Type: string
Description: Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.
Location: query
parent
Type: string
Description: Required. The parent, which owns this collection of batches.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
pageSize
Location: query
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
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches
Description: Lists batch workloads.
Parameter Order: parent
▼ ▲ dataproc.projects.locations.batches.get
Path: v1/{+name}
Description: Gets the batch workload resource representation.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}
Parameters:
name
Description: Required. The name of the batch to retrieve.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+$
Location: path
Required: Yes
Parameter Order: name
▼ ▲ dataproc.projects.locations.batches.create
Parameter Order: parent
Description: Creates a batch workload that executes asynchronously.
Path: v1/{+parent}/batches
Parameters:
parent
Type: string
Description: Required. The parent resource where this batch will be created.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
requestId
Type: string
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.
Location: query
batchId
Type: string
Location: query
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]-/.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches
▼ ▲ dataproc.projects.locations.batches.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Description: Required. The name of the batch resource to delete.
Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+$
Required: Yes
Location: path
Type: string
Description: Deletes the batch workload resource. If the batch is not in terminal state, the delete fails and the response returns FAILED_PRECONDITION.
HTTP Method: DELETE
▼ ▲ dataproc.projects.locations.batches.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1/{+parent}/batches
Parameters:
pageToken
Type: string
Description: Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.
Location: query
parent
Type: string
Description: Required. The parent, which owns this collection of batches.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
pageSize
Location: query
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
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches
Description: Lists batch workloads.
Parameter Order: parent
▼ ▲ dataproc.projects.locations.batches.get
Path: v1/{+name}
Description: Gets the batch workload resource representation.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}
Parameters:
name
Description: Required. The name of the batch to retrieve.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+$
Location: path
Required: Yes
Parameter Order: name
▼ ▲ dataproc.projects.locations.batches.create
Parameter Order: parent
Description: Creates a batch workload that executes asynchronously.
Path: v1/{+parent}/batches
Parameters:
parent
Type: string
Description: Required. The parent resource where this batch will be created.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
requestId
Type: string
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.
Location: query
batchId
Type: string
Location: query
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]-/.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches