Google Cloud Hypercompute Cluster V1beta Client - Class HypercomputeClusterClient (0.1.0)

Reference documentation and code samples for the Google Cloud Hypercompute Cluster V1beta Client class HypercomputeClusterClient.

Service Description: Service describing handlers for resources

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

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 \ HypercomputeCluster \ V1beta \ Client

Methods

__construct

Constructor.

Parameters
Name Description
options array|Google\ApiCore\Options\ClientOptions

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 FetchAuthTokenInterface|CredentialsWrapper

This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\HypercomputeCluster\V1beta\HypercomputeClusterClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new HypercomputeClusterClient(['credentials' => $creds]); https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

↳ 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.

↳ logger false|LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

↳ universeDomain string

The service domain for the client. Defaults to 'googleapis.com'.

createCluster

Creates a new Cluster in a given project and location.

The async variant is HypercomputeClusterClient::createClusterAsync() .

Parameters
Name Description
request Google\Cloud\HypercomputeCluster\V1beta\CreateClusterRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ 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<Google\Cloud\HypercomputeCluster\V1beta\Cluster>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\HypercomputeCluster\V1beta\Client\HypercomputeClusterClient;
use Google\Cloud\HypercomputeCluster\V1beta\Cluster;
use Google\Cloud\HypercomputeCluster\V1beta\CreateClusterRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent Parent location in which the cluster should be created, in the
 *                                format `projects/{project}/locations/{location}`. Please see
 *                                {@see HypercomputeClusterClient::locationName()} for help formatting this field.
 * @param string $clusterId       ID of the cluster to create. Must conform to
 *                                [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case,
 *                                alphanumeric, and at most 63 characters).
 */
function create_cluster_sample(string $formattedParent, string $clusterId): void
{
    // Create a client.
    $hypercomputeClusterClient = new HypercomputeClusterClient();

    // Prepare the request message.
    $cluster = new Cluster();
    $request = (new CreateClusterRequest())
        ->setParent($formattedParent)
        ->setClusterId($clusterId)
        ->setCluster($cluster);

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

        if ($response->operationSucceeded()) {
            /** @var Cluster $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 = HypercomputeClusterClient::locationName('[PROJECT]', '[LOCATION]');
    $clusterId = '[CLUSTER_ID]';

    create_cluster_sample($formattedParent, $clusterId);
}

deleteCluster

Deletes a single Cluster.

The async variant is HypercomputeClusterClient::deleteClusterAsync() .

Parameters
Name Description
request Google\Cloud\HypercomputeCluster\V1beta\DeleteClusterRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ 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<null>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\HypercomputeCluster\V1beta\Client\HypercomputeClusterClient;
use Google\Cloud\HypercomputeCluster\V1beta\DeleteClusterRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the cluster to delete, in the format
 *                              `projects/{project}/locations/{location}/clusters/{cluster}`. Please see
 *                              {@see HypercomputeClusterClient::clusterName()} for help formatting this field.
 */
function delete_cluster_sample(string $formattedName): void
{
    // Create a client.
    $hypercomputeClusterClient = new HypercomputeClusterClient();

    // Prepare the request message.
    $request = (new DeleteClusterRequest())
        ->setName($formattedName);

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

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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 = HypercomputeClusterClient::clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]');

    delete_cluster_sample($formattedName);
}

getCluster

Gets details of a single Cluster.

The async variant is HypercomputeClusterClient::getClusterAsync() .

Parameters
Name Description
request Google\Cloud\HypercomputeCluster\V1beta\GetClusterRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ 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\Cloud\HypercomputeCluster\V1beta\Cluster
Example
use Google\ApiCore\ApiException;
use Google\Cloud\HypercomputeCluster\V1beta\Client\HypercomputeClusterClient;
use Google\Cloud\HypercomputeCluster\V1beta\Cluster;
use Google\Cloud\HypercomputeCluster\V1beta\GetClusterRequest;

/**
 * @param string $formattedName Name of the cluster to retrieve, in the format
 *                              `projects/{project}/locations/{location}/clusters/{cluster}`. Please see
 *                              {@see HypercomputeClusterClient::clusterName()} for help formatting this field.
 */
function get_cluster_sample(string $formattedName): void
{
    // Create a client.
    $hypercomputeClusterClient = new HypercomputeClusterClient();

    // Prepare the request message.
    $request = (new GetClusterRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Cluster $response */
        $response = $hypercomputeClusterClient->getCluster($request);
        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 = HypercomputeClusterClient::clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]');

    get_cluster_sample($formattedName);
}

listClusters

Lists Clusters in a given project and location.

The async variant is HypercomputeClusterClient::listClustersAsync() .

Parameters
Name Description
request Google\Cloud\HypercomputeCluster\V1beta\ListClustersRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ 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\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\HypercomputeCluster\V1beta\Client\HypercomputeClusterClient;
use Google\Cloud\HypercomputeCluster\V1beta\Cluster;
use Google\Cloud\HypercomputeCluster\V1beta\ListClustersRequest;

/**
 * @param string $formattedParent Parent location of the clusters to list, in the format
 *                                `projects/{project}/locations/{location}`. Please see
 *                                {@see HypercomputeClusterClient::locationName()} for help formatting this field.
 */
function list_clusters_sample(string $formattedParent): void
{
    // Create a client.
    $hypercomputeClusterClient = new HypercomputeClusterClient();

    // Prepare the request message.
    $request = (new ListClustersRequest())
        ->setParent($formattedParent);

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

        /** @var Cluster $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 = HypercomputeClusterClient::locationName('[PROJECT]', '[LOCATION]');

    list_clusters_sample($formattedParent);
}

updateCluster

Updates the parameters of a single Cluster.

The async variant is HypercomputeClusterClient::updateClusterAsync() .

Parameters
Name Description
request Google\Cloud\HypercomputeCluster\V1beta\UpdateClusterRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ 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<Google\Cloud\HypercomputeCluster\V1beta\Cluster>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\HypercomputeCluster\V1beta\Client\HypercomputeClusterClient;
use Google\Cloud\HypercomputeCluster\V1beta\Cluster;
use Google\Cloud\HypercomputeCluster\V1beta\UpdateClusterRequest;
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 update_cluster_sample(): void
{
    // Create a client.
    $hypercomputeClusterClient = new HypercomputeClusterClient();

    // Prepare the request message.
    $cluster = new Cluster();
    $request = (new UpdateClusterRequest())
        ->setCluster($cluster);

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

        if ($response->operationSucceeded()) {
            /** @var Cluster $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.

The async variant is HypercomputeClusterClient::getLocationAsync() .

Parameters
Name Description
request Google\Cloud\Location\GetLocationRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ 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\Cloud\Location\Location
Example
use Google\ApiCore\ApiException;
use Google\Cloud\HypercomputeCluster\V1beta\Client\HypercomputeClusterClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * 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.
    $hypercomputeClusterClient = new HypercomputeClusterClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $hypercomputeClusterClient->getLocation($request);
        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.

The async variant is HypercomputeClusterClient::listLocationsAsync() .

Parameters
Name Description
request Google\Cloud\Location\ListLocationsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ 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\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\HypercomputeCluster\V1beta\Client\HypercomputeClusterClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

/**
 * 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.
    $hypercomputeClusterClient = new HypercomputeClusterClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

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

createClusterAsync

Parameters
Name Description
request Google\Cloud\HypercomputeCluster\V1beta\CreateClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteClusterAsync

Parameters
Name Description
request Google\Cloud\HypercomputeCluster\V1beta\DeleteClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getClusterAsync

Parameters
Name Description
request Google\Cloud\HypercomputeCluster\V1beta\GetClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\HypercomputeCluster\V1beta\Cluster>

listClustersAsync

Parameters
Name Description
request Google\Cloud\HypercomputeCluster\V1beta\ListClustersRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

updateClusterAsync

Parameters
Name Description
request Google\Cloud\HypercomputeCluster\V1beta\UpdateClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getLocationAsync

Parameters
Name Description
request Google\Cloud\Location\GetLocationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>

listLocationsAsync

Parameters
Name Description
request Google\Cloud\Location\ListLocationsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

getOperationsClient

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

Returns
Type Description
Google\LongRunning\Client\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::bucketName

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

Parameters
Name Description
project string
bucket string
Returns
Type Description
string The formatted bucket resource.

static::clusterName

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

Parameters
Name Description
project string
location string
cluster string
Returns
Type Description
string The formatted cluster resource.

static::computeInstanceName

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

Parameters
Name Description
project string
zone string
instance string
Returns
Type Description
string The formatted compute_instance resource.

static::diskTypeName

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

Parameters
Name Description
project string
zone string
diskType string
Returns
Type Description
string The formatted disk_type resource.

static::fileInstanceName

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

Parameters
Name Description
project string
location string
instance string
Returns
Type Description
string The formatted file_instance 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::lustreInstanceName

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

Parameters
Name Description
project string
location string
instance string
Returns
Type Description
string The formatted lustre_instance resource.

static::networkName

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

Parameters
Name Description
project string
network string
Returns
Type Description
string The formatted network resource.

static::reservationName

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

Parameters
Name Description
project string
zone string
reservation string
Returns
Type Description
string The formatted reservation resource.

static::subnetworkName

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

Parameters
Name Description
project string
region string
subnetwork string
Returns
Type Description
string The formatted subnetwork 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

  • bucket: projects/{project}/buckets/{bucket}
  • cluster: projects/{project}/locations/{location}/clusters/{cluster}
  • computeInstance: projects/{project}/zones/{zone}/instances/{instance}
  • diskType: projects/{project}/zones/{zone}/diskTypes/{disk_type}
  • fileInstance: projects/{project}/locations/{location}/instances/{instance}
  • location: projects/{project}/locations/{location}
  • lustreInstance: projects/{project}/locations/{location}/instances/{instance}
  • network: projects/{project}/global/networks/{network}
  • reservation: projects/{project}/zones/{zone}/reservations/{reservation}
  • subnetwork: projects/{project}/regions/{region}/subnetworks/{subnetwork}

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.