Compute V1 Client - Class FutureReservationsClient (2.3.0)

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

Service Description: The FutureReservations 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
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\Compute\V1\FutureReservationsClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new FutureReservationsClient(['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. 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.
`↳ 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 = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method 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'.

aggregatedList

Retrieves an aggregated list of future reservations.

To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.

The async variant is FutureReservationsClient::aggregatedListAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\AggregatedListFutureReservationsRequest` 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\Compute\V1\AggregatedListFutureReservationsRequest;
use Google\Cloud\Compute\V1\Client\FutureReservationsClient;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $futureReservationsClient->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);
}

cancel

Cancel the specified future reservation.

The async variant is FutureReservationsClient::cancelAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\CancelFutureReservationRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\CancelFutureReservationRequest;
use Google\Cloud\Compute\V1\Client\FutureReservationsClient;
use Google\Rpc\Status;

/**
 * @param string $futureReservation Name of the future reservation to retrieve. Name should conform to RFC1035.
 * @param string $project           Project ID for this request.
 * @param string $zone              Name of the zone for this request. Name should conform to RFC1035.
 */
function cancel_sample(string $futureReservation, string $project, string $zone): void
{
    // Create a client.
    $futureReservationsClient = new FutureReservationsClient();

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

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

    cancel_sample($futureReservation, $project, $zone);
}

delete

Deletes the specified future reservation.

The async variant is FutureReservationsClient::deleteAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\DeleteFutureReservationRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\FutureReservationsClient;
use Google\Cloud\Compute\V1\DeleteFutureReservationRequest;
use Google\Rpc\Status;

/**
 * @param string $futureReservation Name of the future reservation to retrieve. Name should conform to RFC1035.
 * @param string $project           Project ID for this request.
 * @param string $zone              Name of the zone for this request. Name should conform to RFC1035.
 */
function delete_sample(string $futureReservation, string $project, string $zone): void
{
    // Create a client.
    $futureReservationsClient = new FutureReservationsClient();

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

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

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

get

Retrieves information about the specified future reservation.

The async variant is FutureReservationsClient::getAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\GetFutureReservationRequest` 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\Compute\V1\FutureReservation`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\FutureReservationsClient;
use Google\Cloud\Compute\V1\FutureReservation;
use Google\Cloud\Compute\V1\GetFutureReservationRequest;

/**
 * @param string $futureReservation Name of the future reservation to retrieve. Name should conform to RFC1035.
 * @param string $project           Project ID for this request.
 * @param string $zone              Name of the zone for this request. Name should conform to RFC1035.
 */
function get_sample(string $futureReservation, string $project, string $zone): void
{
    // Create a client.
    $futureReservationsClient = new FutureReservationsClient();

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

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

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

insert

Creates a new Future Reservation.

The async variant is FutureReservationsClient::insertAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\InsertFutureReservationRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\FutureReservationsClient;
use Google\Cloud\Compute\V1\FutureReservation;
use Google\Cloud\Compute\V1\InsertFutureReservationRequest;
use Google\Rpc\Status;

/**
 * @param string $project Project ID for this request.
 * @param string $zone    Name of the zone for this request. Name should conform to RFC1035.
 */
function insert_sample(string $project, string $zone): void
{
    // Create a client.
    $futureReservationsClient = new FutureReservationsClient();

    // Prepare the request message.
    $futureReservationResource = new FutureReservation();
    $request = (new InsertFutureReservationRequest())
        ->setFutureReservationResource($futureReservationResource)
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $futureReservationsClient->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

A list of all the future reservations that have been configured for the specified project in specified zone.

The async variant is FutureReservationsClient::listAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\ListFutureReservationsRequest` 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\Compute\V1\Client\FutureReservationsClient;
use Google\Cloud\Compute\V1\ListFutureReservationsRequest;

/**
 * @param string $project Project ID for this request.
 * @param string $zone    Name of the zone for this request. Name should conform to RFC1035.
 */
function list_sample(string $project, string $zone): void
{
    // Create a client.
    $futureReservationsClient = new FutureReservationsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $futureReservationsClient->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);
}

update

Updates the specified future reservation.

The async variant is FutureReservationsClient::updateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\UpdateFutureReservationRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\FutureReservationsClient;
use Google\Cloud\Compute\V1\FutureReservation;
use Google\Cloud\Compute\V1\UpdateFutureReservationRequest;
use Google\Rpc\Status;

/**
 * @param string $futureReservation Name of the reservation to update. Name should conform to RFC1035.
 * @param string $project           Project ID for this request.
 * @param string $zone              Name of the zone for this request. Name should conform to RFC1035.
 */
function update_sample(string $futureReservation, string $project, string $zone): void
{
    // Create a client.
    $futureReservationsClient = new FutureReservationsClient();

    // Prepare the request message.
    $futureReservationResource = new FutureReservation();
    $request = (new UpdateFutureReservationRequest())
        ->setFutureReservation($futureReservation)
        ->setFutureReservationResource($futureReservationResource)
        ->setProject($project)
        ->setZone($zone);

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

    update_sample($futureReservation, $project, $zone);
}

aggregatedListAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\AggregatedListFutureReservationsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

cancelAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\CancelFutureReservationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

deleteAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\DeleteFutureReservationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

getAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\GetFutureReservationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\FutureReservation>`

insertAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\InsertFutureReservationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

listAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\ListFutureReservationsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

updateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\UpdateFutureReservationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

getOperationsClient

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

Returns
Type	Description
`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
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`

Compute V1 Client - Class FutureReservationsClient (2.3.0) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

aggregatedList

cancel

delete

get

insert

list

update

aggregatedListAsync

cancelAsync

deleteAsync

getAsync

insertAsync

listAsync

updateAsync

getOperationsClient

resumeOperation

Compute V1 Client - Class FutureReservationsClient (2.3.0)