1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Dataproc
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsBatches

ProjectsLocationsBatches

class ProjectsLocationsBatches extends Resource (View source)

The "batches" collection of methods.

Typical usage is:

 $dataprocService = new Google\Service\Dataproc(...);
 $batches = $dataprocService->projects_locations_batches;

Methods

Operation
analyze(string $name, AnalyzeBatchRequest $postBody, array $optParams = [])

Analyze a Batch for possible recommendations and insights. (batches.analyze)

Operation
create(string $parent, Batch $postBody, array $optParams = [])

Creates a batch workload that executes asynchronously. (batches.create)

DataprocEmpty
delete(string $name, array $optParams = [])

Deletes the batch workload resource. If the batch is not in a CANCELLED, SUCCEEDED or FAILED State, the delete operation fails and the response returns FAILED_PRECONDITION. (batches.delete)

Batch
get(string $name, array $optParams = [])

Gets the batch workload resource representation. (batches.get)

ListBatchesResponse
listProjectsLocationsBatches(string $parent, array $optParams = [])

Lists batch workloads. (batches.listProjectsLocationsBatches)

Details

at line 47
Operation analyze(string $name, AnalyzeBatchRequest $postBody, array $optParams = [])

Analyze a Batch for possible recommendations and insights. (batches.analyze)

Parameters

string $name

Required. The fully qualified name of the batch to analyze in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"
AnalyzeBatchRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 76
Operation create(string $parent, Batch $postBody, array $optParams = [])

Creates a batch workload that executes asynchronously. (batches.create)

Parameters

string $parent

Required. The parent resource where this batch will be created.
Batch $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 94
DataprocEmpty delete(string $name, array $optParams = [])

Deletes the batch workload resource. If the batch is not in a CANCELLED, SUCCEEDED or FAILED State, the delete operation fails and the response returns FAILED_PRECONDITION. (batches.delete)

Parameters

string $name

Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"
array $optParams

Optional parameters.

Return Value

DataprocEmpty

Exceptions

Exception

at line 110
Batch get(string $name, array $optParams = [])

Gets the batch workload resource representation. (batches.get)

Parameters

string $name

Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"
array $optParams

Optional parameters.

Return Value

Batch

Exceptions

Exception

at line 146
ListBatchesResponse listProjectsLocationsBatches(string $parent, array $optParams = [])

Lists batch workloads. (batches.listProjectsLocationsBatches)

Parameters

string $parent

Required. The parent, which owns this collection of batches.
array $optParams

Optional parameters.

Return Value

ListBatchesResponse

Exceptions

Exception