Google Cloud Dataproc V1 Client - Class BatchControllerClient (3.2.2)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class BatchControllerClient.

Service Description: The BatchController provides methods to manage batch workloads.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$batchControllerClient = new BatchControllerClient();
try {
    $formattedParent = $batchControllerClient->locationName('[PROJECT]', '[LOCATION]');
    $batch = new Batch();
    $operationResponse = $batchControllerClient->createBatch($formattedParent, $batch);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $batchControllerClient->createBatch($formattedParent, $batch);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $batchControllerClient->resumeOperation($operationName, 'createBatch');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $batchControllerClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Methods

batchName

Formats a string containing the fully-qualified path to represent a batch resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`batch`	`string`

Returns
Type	Description
`string`	The formatted batch resource.

locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

batch: projects/{project}/locations/{location}/batches/{batch}
location: projects/{project}/locations/{location}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed {@see} object or {@see} object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see {@see} .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated {@see} object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the {@see} and {@see} methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createBatch

Creates a batch workload that executes asynchronously.

Parameters
Name	Description
`parent`	`string` Required. The parent resource where this batch will be created.
`batch`	`Google\Cloud\Dataproc\V1\Batch` Required. The batch to create.
`optionalArgs`	`array` Optional.
`↳ batchId`	`string` 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`	`string` Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequests 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. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataproc\V1\Batch;
use Google\Cloud\Dataproc\V1\BatchControllerClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent resource where this batch will be created. Please see
 *                                {@see BatchControllerClient::locationName()} for help formatting this field.
 */
function create_batch_sample(string $formattedParent): void
{
    // Create a client.
    $batchControllerClient = new BatchControllerClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $batch = new Batch();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $batchControllerClient->createBatch($formattedParent, $batch);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Batch $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = BatchControllerClient::locationName('[PROJECT]', '[LOCATION]');

    create_batch_sample($formattedParent);
}

deleteBatch

Deletes the batch workload resource. If the batch is not in terminal state, the delete fails and the response returns FAILED_PRECONDITION.

Parameters
Name	Description
`name`	`string` Required. The name of the batch resource to delete.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\BatchControllerClient;

/**
 * @param string $formattedName The name of the batch resource to delete. Please see
 *                              {@see BatchControllerClient::batchName()} for help formatting this field.
 */
function delete_batch_sample(string $formattedName): void
{
    // Create a client.
    $batchControllerClient = new BatchControllerClient();

    // Call the API and handle any network failures.
    try {
        $batchControllerClient->deleteBatch($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = BatchControllerClient::batchName('[PROJECT]', '[LOCATION]', '[BATCH]');

    delete_batch_sample($formattedName);
}

getBatch

Gets the batch workload resource representation.

Parameters
Name	Description
`name`	`string` Required. The name of the batch to retrieve.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Dataproc\V1\Batch`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Batch;
use Google\Cloud\Dataproc\V1\BatchControllerClient;

/**
 * @param string $formattedName The name of the batch to retrieve. Please see
 *                              {@see BatchControllerClient::batchName()} for help formatting this field.
 */
function get_batch_sample(string $formattedName): void
{
    // Create a client.
    $batchControllerClient = new BatchControllerClient();

    // Call the API and handle any network failures.
    try {
        /** @var Batch $response */
        $response = $batchControllerClient->getBatch($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = BatchControllerClient::batchName('[PROJECT]', '[LOCATION]', '[BATCH]');

    get_batch_sample($formattedName);
}

listBatches

Lists batch workloads.

Parameters
Name	Description
`parent`	`string` Required. The parent, which owns this collection of batches.
`optionalArgs`	`array` Optional.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataproc\V1\Batch;
use Google\Cloud\Dataproc\V1\BatchControllerClient;

/**
 * @param string $formattedParent The parent, which owns this collection of batches. Please see
 *                                {@see BatchControllerClient::locationName()} for help formatting this field.
 */
function list_batches_sample(string $formattedParent): void
{
    // Create a client.
    $batchControllerClient = new BatchControllerClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $batchControllerClient->listBatches($formattedParent);

        /** @var Batch $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = BatchControllerClient::locationName('[PROJECT]', '[LOCATION]');

    list_batches_sample($formattedParent);
}

Constants

SERVICE_NAME

Value: 'google.cloud.dataproc.v1.BatchController'

The name of the service.

SERVICE_ADDRESS

Value: 'dataproc.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.