Compute V1 Client - Class InstantSnapshotGroupsClient (2.9.0)

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

Service Description: The InstantSnapshotGroups 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\InstantSnapshotGroupsClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new InstantSnapshotGroupsClient(['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'.

delete

deletes a Zonal InstantSnapshotGroup resource

The async variant is InstantSnapshotGroupsClient::deleteAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\DeleteInstantSnapshotGroupRequest` 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\InstantSnapshotGroupsClient;
use Google\Cloud\Compute\V1\DeleteInstantSnapshotGroupRequest;
use Google\Rpc\Status;

/**
 * @param string $instantSnapshotGroup Name of the InstantSnapshot resource to delete.
 * @param string $project              Project ID for this request.
 * @param string $zone                 The name of the zone for this request.
 */
function delete_sample(string $instantSnapshotGroup, string $project, string $zone): void
{
    // Create a client.
    $instantSnapshotGroupsClient = new InstantSnapshotGroupsClient();

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

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

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

get

returns the specified InstantSnapshotGroup resource in the specified zone.

The async variant is InstantSnapshotGroupsClient::getAsync() .

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\InstantSnapshotGroupsClient;
use Google\Cloud\Compute\V1\GetInstantSnapshotGroupRequest;
use Google\Cloud\Compute\V1\InstantSnapshotGroup;

/**
 * @param string $instantSnapshotGroup Name of the InstantSnapshotGroup resource to return.
 * @param string $project              Project ID for this request.
 * @param string $zone                 The name of the zone for this request.
 */
function get_sample(string $instantSnapshotGroup, string $project, string $zone): void
{
    // Create a client.
    $instantSnapshotGroupsClient = new InstantSnapshotGroupsClient();

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

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

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

getIamPolicy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

The async variant is InstantSnapshotGroupsClient::getIamPolicyAsync() .

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\InstantSnapshotGroupsClient;
use Google\Cloud\Compute\V1\GetIamPolicyInstantSnapshotGroupRequest;
use Google\Cloud\Compute\V1\Policy;

/**
 * @param string $project  Project ID for this request.
 * @param string $resource Name or id of the resource for this request.
 * @param string $zone     The name of the zone for this request.
 */
function get_iam_policy_sample(string $project, string $resource, string $zone): void
{
    // Create a client.
    $instantSnapshotGroupsClient = new InstantSnapshotGroupsClient();

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

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

    get_iam_policy_sample($project, $resource, $zone);
}

insert

inserts a Zonal InstantSnapshotGroup resource

The async variant is InstantSnapshotGroupsClient::insertAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\InsertInstantSnapshotGroupRequest` 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\InstantSnapshotGroupsClient;
use Google\Cloud\Compute\V1\InsertInstantSnapshotGroupRequest;
use Google\Cloud\Compute\V1\InstantSnapshotGroup;
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.
    $instantSnapshotGroupsClient = new InstantSnapshotGroupsClient();

    // Prepare the request message.
    $instantSnapshotGroupResource = new InstantSnapshotGroup();
    $request = (new InsertInstantSnapshotGroupRequest())
        ->setInstantSnapshotGroupResource($instantSnapshotGroupResource)
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $instantSnapshotGroupsClient->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 the list of InstantSnapshotGroup resources contained within the specified zone.

The async variant is InstantSnapshotGroupsClient::listAsync() .

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

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

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

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

setIamPolicy

Sets the access control policy on the specified resource.

Replaces any existing policy.

The async variant is InstantSnapshotGroupsClient::setIamPolicyAsync() .

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\InstantSnapshotGroupsClient;
use Google\Cloud\Compute\V1\Policy;
use Google\Cloud\Compute\V1\SetIamPolicyInstantSnapshotGroupRequest;
use Google\Cloud\Compute\V1\ZoneSetPolicyRequest;

/**
 * @param string $project  Project ID for this request.
 * @param string $resource Name or id of the resource for this request.
 * @param string $zone     The name of the zone for this request.
 */
function set_iam_policy_sample(string $project, string $resource, string $zone): void
{
    // Create a client.
    $instantSnapshotGroupsClient = new InstantSnapshotGroupsClient();

    // Prepare the request message.
    $zoneSetPolicyRequestResource = new ZoneSetPolicyRequest();
    $request = (new SetIamPolicyInstantSnapshotGroupRequest())
        ->setProject($project)
        ->setResource($resource)
        ->setZone($zone)
        ->setZoneSetPolicyRequestResource($zoneSetPolicyRequestResource);

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

    set_iam_policy_sample($project, $resource, $zone);
}

testIamPermissions

Returns permissions that a caller has on the specified resource.

The async variant is InstantSnapshotGroupsClient::testIamPermissionsAsync() .

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\InstantSnapshotGroupsClient;
use Google\Cloud\Compute\V1\TestIamPermissionsInstantSnapshotGroupRequest;
use Google\Cloud\Compute\V1\TestPermissionsRequest;
use Google\Cloud\Compute\V1\TestPermissionsResponse;

/**
 * @param string $project  Project ID for this request.
 * @param string $resource Name or id of the resource for this request.
 * @param string $zone     The name of the zone for this request.
 */
function test_iam_permissions_sample(string $project, string $resource, string $zone): void
{
    // Create a client.
    $instantSnapshotGroupsClient = new InstantSnapshotGroupsClient();

    // Prepare the request message.
    $testPermissionsRequestResource = new TestPermissionsRequest();
    $request = (new TestIamPermissionsInstantSnapshotGroupRequest())
        ->setProject($project)
        ->setResource($resource)
        ->setTestPermissionsRequestResource($testPermissionsRequestResource)
        ->setZone($zone);

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

    test_iam_permissions_sample($project, $resource, $zone);
}

deleteAsync

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

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

getAsync

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

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

getIamPolicyAsync

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

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

insertAsync

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

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

listAsync

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

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

setIamPolicyAsync

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

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

testIamPermissionsAsync

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

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

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 InstantSnapshotGroupsClient (2.9.0) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

delete

get

getIamPolicy

insert

list

setIamPolicy

testIamPermissions

deleteAsync

getAsync

getIamPolicyAsync

insertAsync

listAsync

setIamPolicyAsync

testIamPermissionsAsync

getOperationsClient

resumeOperation

Compute V1 Client - Class InstantSnapshotGroupsClient (2.9.0)