Compute V1 Client - Class AutoscalersClient (1.27.0)

Reference documentation and code samples for the Compute V1 Client class AutoscalersClient.

Service Description: The Autoscalers API.

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

Namespace

Google \ Cloud \ Compute \ V1 \ Client

Methods

__construct

Constructor.

Parameters
NameDescription
optionsarray

Optional. Options for configuring the service API wrapper.

↳ apiEndpointstring

The address of the API remote host. May optionally include the port, formatted as "

↳ credentialsstring|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. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

↳ credentialsConfigarray

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() .

↳ disableRetriesbool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.

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

↳ transportstring|TransportInterface

The transport used for executing network requests. At the moment, supports only rest. 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.

↳ transportConfigarray

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 = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options.

↳ clientCertSourcecallable

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.

↳ loggerfalse|LoggerInterface

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

aggregatedList

Retrieves an aggregated list of autoscalers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

The async variant is AutoscalersClient::aggregatedListAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\AggregatedListAutoscalersRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|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
TypeDescription
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\AggregatedListAutoscalersRequest;
use Google\Cloud\Compute\V1\Client\AutoscalersClient;

/**
 * @param string $project Project ID for this request.
 */
function aggregated_list_sample(string $project): void
{
    // Create a client.
    $autoscalersClient = new AutoscalersClient();

    // Prepare the request message.
    $request = (new AggregatedListAutoscalersRequest())
        ->setProject($project);

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

        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
{
    $project = '[PROJECT]';

    aggregated_list_sample($project);
}

delete

Deletes the specified autoscaler.

The async variant is AutoscalersClient::deleteAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\DeleteAutoscalerRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|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
TypeDescription
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\AutoscalersClient;
use Google\Cloud\Compute\V1\DeleteAutoscalerRequest;
use Google\Rpc\Status;

/**
 * @param string $autoscaler Name of the autoscaler to delete.
 * @param string $project    Project ID for this request.
 * @param string $zone       Name of the zone for this request.
 */
function delete_sample(string $autoscaler, string $project, string $zone): void
{
    // Create a client.
    $autoscalersClient = new AutoscalersClient();

    // Prepare the request message.
    $request = (new DeleteAutoscalerRequest())
        ->setAutoscaler($autoscaler)
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $autoscalersClient->delete($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
{
    $autoscaler = '[AUTOSCALER]';
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    delete_sample($autoscaler, $project, $zone);
}

get

Returns the specified autoscaler resource.

The async variant is AutoscalersClient::getAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\GetAutoscalerRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|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
TypeDescription
Google\Cloud\Compute\V1\Autoscaler
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Autoscaler;
use Google\Cloud\Compute\V1\Client\AutoscalersClient;
use Google\Cloud\Compute\V1\GetAutoscalerRequest;

/**
 * @param string $autoscaler Name of the autoscaler to return.
 * @param string $project    Project ID for this request.
 * @param string $zone       Name of the zone for this request.
 */
function get_sample(string $autoscaler, string $project, string $zone): void
{
    // Create a client.
    $autoscalersClient = new AutoscalersClient();

    // Prepare the request message.
    $request = (new GetAutoscalerRequest())
        ->setAutoscaler($autoscaler)
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var Autoscaler $response */
        $response = $autoscalersClient->get($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
{
    $autoscaler = '[AUTOSCALER]';
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    get_sample($autoscaler, $project, $zone);
}

insert

Creates an autoscaler in the specified project using the data included in the request.

The async variant is AutoscalersClient::insertAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\InsertAutoscalerRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|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
TypeDescription
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Autoscaler;
use Google\Cloud\Compute\V1\Client\AutoscalersClient;
use Google\Cloud\Compute\V1\InsertAutoscalerRequest;
use Google\Rpc\Status;

/**
 * @param string $project Project ID for this request.
 * @param string $zone    Name of the zone for this request.
 */
function insert_sample(string $project, string $zone): void
{
    // Create a client.
    $autoscalersClient = new AutoscalersClient();

    // Prepare the request message.
    $autoscalerResource = new Autoscaler();
    $request = (new InsertAutoscalerRequest())
        ->setAutoscalerResource($autoscalerResource)
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $autoscalersClient->insert($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
{
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    insert_sample($project, $zone);
}

list

Retrieves a list of autoscalers contained within the specified zone.

The async variant is AutoscalersClient::listAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\ListAutoscalersRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|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
TypeDescription
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\AutoscalersClient;
use Google\Cloud\Compute\V1\ListAutoscalersRequest;

/**
 * @param string $project Project ID for this request.
 * @param string $zone    Name of the zone for this request.
 */
function list_sample(string $project, string $zone): void
{
    // Create a client.
    $autoscalersClient = new AutoscalersClient();

    // Prepare the request message.
    $request = (new ListAutoscalersRequest())
        ->setProject($project)
        ->setZone($zone);

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

        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
{
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    list_sample($project, $zone);
}

Updates an autoscaler in the specified project using the data included in the request. This method supports semantics and uses the JSON merge format and processing rules.

The async variant is AutoscalersClient::Async() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\AutoscalerRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|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
TypeDescription
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Autoscaler;
use Google\Cloud\Compute\V1\Client\AutoscalersClient;
use Google\Cloud\Compute\V1\AutoscalerRequest;
use Google\Rpc\Status;

/**
 * @param string $project Project ID for this request.
 * @param string $zone    Name of the zone for this request.
 */
function _sample(string $project, string $zone): void
{
    // Create a client.
    $autoscalersClient = new AutoscalersClient();

    // Prepare the request message.
    $autoscalerResource = new Autoscaler();
    $request = (new AutoscalerRequest())
        ->setAutoscalerResource($autoscalerResource)
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $autoscalersClient->($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
{
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    _sample($project, $zone);
}

update

Updates an autoscaler in the specified project using the data included in the request.

The async variant is AutoscalersClient::updateAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\UpdateAutoscalerRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|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
TypeDescription
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Autoscaler;
use Google\Cloud\Compute\V1\Client\AutoscalersClient;
use Google\Cloud\Compute\V1\UpdateAutoscalerRequest;
use Google\Rpc\Status;

/**
 * @param string $project Project ID for this request.
 * @param string $zone    Name of the zone for this request.
 */
function update_sample(string $project, string $zone): void
{
    // Create a client.
    $autoscalersClient = new AutoscalersClient();

    // Prepare the request message.
    $autoscalerResource = new Autoscaler();
    $request = (new UpdateAutoscalerRequest())
        ->setAutoscalerResource($autoscalerResource)
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $autoscalersClient->update($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
{
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    update_sample($project, $zone);
}

aggregatedListAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\AggregatedListAutoscalersRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

deleteAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\DeleteAutoscalerRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\GetAutoscalerRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Autoscaler>

insertAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\InsertAutoscalerRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

listAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\ListAutoscalersRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

Async

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\AutoscalerRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

updateAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\UpdateAutoscalerRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getOperationsClient

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

Returns
TypeDescription
Google\Cloud\Compute\V1\ZoneOperationsClient

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
NameDescription
operationNamestring

The name of the long running operation

methodNamestring

The name of the method used to start the operation

Returns
TypeDescription
Google\ApiCore\OperationResponse