Google Cloud Tpu V1 Client - Class TpuClient (1.3.2)

Reference documentation and code samples for the Google Cloud Tpu V1 Client class TpuClient.

Service Description: Manages TPU nodes and other resources

TPU API v1

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:

 $tpuClient = new TpuClient();
try {
    $formattedParent = $tpuClient->locationName('[PROJECT]', '[LOCATION]');
    $node = new Node();
    $operationResponse = $tpuClient->createNode($formattedParent, $node);
    $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 = $tpuClient->createNode($formattedParent, $node);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $tpuClient->resumeOperation($operationName, 'createNode');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $tpuClient->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.

Namespace

Google \ Cloud \ Tpu \ V1

Methods

__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 Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper 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 Google\ApiCore\CredentialsWrapper::build() .

↳ 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 Google\ApiCore\Transport\TransportInterface 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 Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() 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.

createNode

Creates a node.

Parameters

Name

Description

parent

string

Required. The parent resource name.

node

 Google\Cloud\Tpu\V1\Node

Required. The node.

optionalArgs

array

Optional.

↳ nodeId

string

The unqualified resource name.

↳ retrySettings

RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns

Type

Description

 Google\ApiCore\OperationResponse

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Tpu\V1\Node;
use Google\Cloud\Tpu\V1\TpuClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent       The parent resource name. Please see
 *                                      {@see TpuClient::locationName()} for help formatting this field.
 * @param string $nodeAcceleratorType   The type of hardware accelerators associated with this node.
 * @param string $nodeTensorflowVersion The version of Tensorflow running in the Node.
 */
function create_node_sample(
    string $formattedParent,
    string $nodeAcceleratorType,
    string $nodeTensorflowVersion
): void {
    // Create a client.
    $tpuClient = new TpuClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $node = (new Node())
        ->setAcceleratorType($nodeAcceleratorType)
        ->setTensorflowVersion($nodeTensorflowVersion);

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

        if ($response->operationSucceeded()) {
            /** @var Node $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());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 = TpuClient::locationName('[PROJECT]', '[LOCATION]');
    $nodeAcceleratorType = '[ACCELERATOR_TYPE]';
    $nodeTensorflowVersion = '[TENSORFLOW_VERSION]';

    create_node_sample($formattedParent, $nodeAcceleratorType, $nodeTensorflowVersion);
}

deleteNode

Deletes a node.

Parameters

Name

Description

name

string

Required. The resource name.

optionalArgs

array

Optional.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\ApiCore\OperationResponse

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Tpu\V1\Node;
use Google\Cloud\Tpu\V1\TpuClient;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource name. Please see
 *                              {@see TpuClient::nodeName()} for help formatting this field.
 */
function delete_node_sample(string $formattedName): void
{
    // Create a client.
    $tpuClient = new TpuClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $tpuClient->deleteNode($formattedName);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Node $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());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 = TpuClient::nodeName('[PROJECT]', '[LOCATION]', '[NODE]');

    delete_node_sample($formattedName);
}

getAcceleratorType

Gets AcceleratorType.

Parameters

Name

Description

name

string

Required. The resource name.

optionalArgs

array

Optional.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\Cloud\Tpu\V1\AcceleratorType

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Tpu\V1\AcceleratorType;
use Google\Cloud\Tpu\V1\TpuClient;

/**
 * @param string $formattedName The resource name. Please see
 *                              {@see TpuClient::acceleratorTypeName()} for help formatting this field.
 */
function get_accelerator_type_sample(string $formattedName): void
{
    // Create a client.
    $tpuClient = new TpuClient();

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

/**
 * Helper to execute the sample.
 *
 * 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 = TpuClient::acceleratorTypeName('[PROJECT]', '[LOCATION]', '[ACCELERATOR_TYPE]');

    get_accelerator_type_sample($formattedName);
}

getNode

Gets the details of a node.

Parameters

Name

Description

name

string

Required. The resource name.

optionalArgs

array

Optional.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\Cloud\Tpu\V1\Node

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Tpu\V1\Node;
use Google\Cloud\Tpu\V1\TpuClient;

/**
 * @param string $formattedName The resource name. Please see
 *                              {@see TpuClient::nodeName()} for help formatting this field.
 */
function get_node_sample(string $formattedName): void
{
    // Create a client.
    $tpuClient = new TpuClient();

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

/**
 * Helper to execute the sample.
 *
 * 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 = TpuClient::nodeName('[PROJECT]', '[LOCATION]', '[NODE]');

    get_node_sample($formattedName);
}

getTensorFlowVersion

Gets TensorFlow Version.

Parameters

Name

Description

name

string

Required. The resource name.

optionalArgs

array

Optional.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\Cloud\Tpu\V1\TensorFlowVersion

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Tpu\V1\TensorFlowVersion;
use Google\Cloud\Tpu\V1\TpuClient;

/**
 * @param string $formattedName The resource name. Please see
 *                              {@see TpuClient::tensorFlowVersionName()} for help formatting this field.
 */
function get_tensor_flow_version_sample(string $formattedName): void
{
    // Create a client.
    $tpuClient = new TpuClient();

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

/**
 * Helper to execute the sample.
 *
 * 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 = TpuClient::tensorFlowVersionName(
        '[PROJECT]',
        '[LOCATION]',
        '[TENSOR_FLOW_VERSION]'
    );

    get_tensor_flow_version_sample($formattedName);
}

listAcceleratorTypes

Lists accelerator types supported by this API.

Parameters

Name

Description

parent

string

Required. The parent resource name.

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.

↳ filter

string

List filter.

↳ orderBy

string

Sort results.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\ApiCore\PagedListResponse

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Tpu\V1\AcceleratorType;
use Google\Cloud\Tpu\V1\TpuClient;

/**
 * @param string $formattedParent The parent resource name. Please see
 *                                {@see TpuClient::acceleratorTypeName()} for help formatting this field.
 */
function list_accelerator_types_sample(string $formattedParent): void
{
    // Create a client.
    $tpuClient = new TpuClient();

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

        /** @var AcceleratorType $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());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 = TpuClient::acceleratorTypeName('[PROJECT]', '[LOCATION]', '[ACCELERATOR_TYPE]');

    list_accelerator_types_sample($formattedParent);
}

listNodes

Lists nodes.

Parameters

Name

Description

parent

string

Required. The parent resource name.

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

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\ApiCore\PagedListResponse

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Tpu\V1\Node;
use Google\Cloud\Tpu\V1\TpuClient;

/**
 * @param string $formattedParent The parent resource name. Please see
 *                                {@see TpuClient::locationName()} for help formatting this field.
 */
function list_nodes_sample(string $formattedParent): void
{
    // Create a client.
    $tpuClient = new TpuClient();

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

        /** @var Node $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());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 = TpuClient::locationName('[PROJECT]', '[LOCATION]');

    list_nodes_sample($formattedParent);
}

listTensorFlowVersions

List TensorFlow versions supported by this API.

Parameters

Name

Description

parent

string

Required. The parent resource name.

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

↳ filter

string

List filter.

↳ orderBy

string

Sort results.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\ApiCore\PagedListResponse

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Tpu\V1\TensorFlowVersion;
use Google\Cloud\Tpu\V1\TpuClient;

/**
 * @param string $formattedParent The parent resource name. Please see
 *                                {@see TpuClient::tensorFlowVersionName()} for help formatting this field.
 */
function list_tensor_flow_versions_sample(string $formattedParent): void
{
    // Create a client.
    $tpuClient = new TpuClient();

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

        /** @var TensorFlowVersion $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());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 = TpuClient::tensorFlowVersionName(
        '[PROJECT]',
        '[LOCATION]',
        '[TENSOR_FLOW_VERSION]'
    );

    list_tensor_flow_versions_sample($formattedParent);
}

reimageNode

Reimages a node's OS.

Parameters

Name

Description

optionalArgs

array

Optional.

↳ name

string

The resource name.

↳ tensorflowVersion

string

The version for reimage to create.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\ApiCore\OperationResponse

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Tpu\V1\Node;
use Google\Cloud\Tpu\V1\TpuClient;
use Google\Rpc\Status;

/**
 * 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 reimage_node_sample(): void
{
    // Create a client.
    $tpuClient = new TpuClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $tpuClient->reimageNode();
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Node $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());
    }
}

startNode

Starts a node.

Parameters

Name

Description

optionalArgs

array

Optional.

↳ name

string

The resource name.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\ApiCore\OperationResponse

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Tpu\V1\Node;
use Google\Cloud\Tpu\V1\TpuClient;
use Google\Rpc\Status;

/**
 * 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 start_node_sample(): void
{
    // Create a client.
    $tpuClient = new TpuClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $tpuClient->startNode();
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Node $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());
    }
}

stopNode

Stops a node, this operation is only available with single TPU nodes.

Parameters

Name

Description

optionalArgs

array

Optional.

↳ name

string

The resource name.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\ApiCore\OperationResponse

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Tpu\V1\Node;
use Google\Cloud\Tpu\V1\TpuClient;
use Google\Rpc\Status;

/**
 * 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 stop_node_sample(): void
{
    // Create a client.
    $tpuClient = new TpuClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $tpuClient->stopNode();
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Node $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());
    }
}

getLocation

Gets information about a location.

Parameters

Name

Description

optionalArgs

array

Optional.

↳ name

string

Resource name for the location.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\Cloud\Location\Location

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Location\Location;
use Google\Cloud\Tpu\V1\TpuClient;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $tpuClient = new TpuClient();

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

listLocations

Lists information about the supported locations for this service.

Parameters

Name

Description

optionalArgs

array

Optional.

↳ name

string

The resource that owns the locations collection, if applicable.

↳ filter

string

The standard list filter.

↳ 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

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\ApiCore\PagedListResponse

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\Location;
use Google\Cloud\Tpu\V1\TpuClient;

/**
 * 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 list_locations_sample(): void
{
    // Create a client.
    $tpuClient = new TpuClient();

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

        /** @var Location $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());
    }
}

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

static::acceleratorTypeName

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

Parameters

Name

Description

project

string

location

string

acceleratorType

string

Returns

Type

Description

string

The formatted accelerator_type resource.

static::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.

static::nodeName

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

Parameters

Name

Description

project

string

location

string

node

string

Returns

Type

Description

string

The formatted node resource.

static::tensorFlowVersionName

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

Parameters

Name

Description

project

string

location

string

tensorFlowVersion

string

Returns

Type

Description

string

The formatted tensor_flow_version resource.

static::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

acceleratorType: projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}
location: projects/{project}/locations/{location}
node: projects/{project}/locations/{location}/nodes/{node}
tensorFlowVersion: projects/{project}/locations/{location}/tensorFlowVersions/{tensor_flow_version}

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.

Constants

SERVICE_NAME

  Value: 'google.cloud.tpu.v1.Tpu'

The name of the service.

SERVICE_ADDRESS

  Value: 'tpu.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.

Google Cloud Tpu V1 Client - Class TpuClient (1.3.2) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

createNode

deleteNode

getAcceleratorType

getNode

getTensorFlowVersion

listAcceleratorTypes

listNodes

listTensorFlowVersions

reimageNode

startNode

stopNode

getLocation

listLocations

getOperationsClient

resumeOperation

static::acceleratorTypeName

static::locationName

static::nodeName

static::tensorFlowVersionName

static::parseName

Constants

SERVICE_NAME

SERVICE_ADDRESS

DEFAULT_SERVICE_PORT

CODEGEN_NAME

Google Cloud Tpu V1 Client - Class TpuClient (1.3.2)