Reference documentation and code samples for the Compute V1 Client class DisksClient.
Service Description: The Disks 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 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ 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 |
↳ 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 |
addResourcePolicies
Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.
The async variant is DisksClient::addResourcePoliciesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AddResourcePoliciesDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\AddResourcePoliciesDiskRequest;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\DisksAddResourcePoliciesRequest;
use Google\Rpc\Status;
/**
* @param string $disk The disk name for this request.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function add_resource_policies_sample(string $disk, string $project, string $zone): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$disksAddResourcePoliciesRequestResource = new DisksAddResourcePoliciesRequest();
$request = (new AddResourcePoliciesDiskRequest())
->setDisk($disk)
->setDisksAddResourcePoliciesRequestResource($disksAddResourcePoliciesRequestResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $disksClient->addResourcePolicies($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
{
$disk = '[DISK]';
$project = '[PROJECT]';
$zone = '[ZONE]';
add_resource_policies_sample($disk, $project, $zone);
}
aggregatedList
Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
The async variant is DisksClient::aggregatedListAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AggregatedListDisksRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\AggregatedListDisksRequest;
use Google\Cloud\Compute\V1\Client\DisksClient;
/**
* @param string $project Project ID for this request.
*/
function aggregated_list_sample(string $project): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$request = (new AggregatedListDisksRequest())
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $disksClient->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);
}
bulkInsert
Bulk create a set of disks.
The async variant is DisksClient::bulkInsertAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\BulkInsertDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\BulkInsertDiskRequest;
use Google\Cloud\Compute\V1\BulkInsertDiskResource;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function bulk_insert_sample(string $project, string $zone): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$bulkInsertDiskResourceResource = new BulkInsertDiskResource();
$request = (new BulkInsertDiskRequest())
->setBulkInsertDiskResourceResource($bulkInsertDiskResourceResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $disksClient->bulkInsert($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]';
bulk_insert_sample($project, $zone);
}
createSnapshot
Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.
The async variant is DisksClient::createSnapshotAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\CreateSnapshotDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\CreateSnapshotDiskRequest;
use Google\Cloud\Compute\V1\Snapshot;
use Google\Rpc\Status;
/**
* @param string $disk Name of the persistent disk to snapshot.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function create_snapshot_sample(string $disk, string $project, string $zone): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$snapshotResource = new Snapshot();
$request = (new CreateSnapshotDiskRequest())
->setDisk($disk)
->setProject($project)
->setSnapshotResource($snapshotResource)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $disksClient->createSnapshot($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
{
$disk = '[DISK]';
$project = '[PROJECT]';
$zone = '[ZONE]';
create_snapshot_sample($disk, $project, $zone);
}
delete
Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.
The async variant is DisksClient::deleteAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\DeleteDiskRequest;
use Google\Rpc\Status;
/**
* @param string $disk Name of the persistent disk 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 $disk, string $project, string $zone): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$request = (new DeleteDiskRequest())
->setDisk($disk)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $disksClient->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
{
$disk = '[DISK]';
$project = '[PROJECT]';
$zone = '[ZONE]';
delete_sample($disk, $project, $zone);
}
get
Returns the specified persistent disk.
The async variant is DisksClient::getAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetDiskRequest
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\Disk |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\Disk;
use Google\Cloud\Compute\V1\GetDiskRequest;
/**
* @param string $disk Name of the persistent disk 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 $disk, string $project, string $zone): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$request = (new GetDiskRequest())
->setDisk($disk)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var Disk $response */
$response = $disksClient->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
{
$disk = '[DISK]';
$project = '[PROJECT]';
$zone = '[ZONE]';
get_sample($disk, $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 DisksClient::getIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetIamPolicyDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\GetIamPolicyDiskRequest;
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.
$disksClient = new DisksClient();
// Prepare the request message.
$request = (new GetIamPolicyDiskRequest())
->setProject($project)
->setResource($resource)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $disksClient->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
Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.
The async variant is DisksClient::insertAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\Disk;
use Google\Cloud\Compute\V1\InsertDiskRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function insert_sample(string $project, string $zone): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$diskResource = new Disk();
$request = (new InsertDiskRequest())
->setDiskResource($diskResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $disksClient->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 persistent disks contained within the specified zone.
The async variant is DisksClient::listAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListDisksRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\ListDisksRequest;
/**
* @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.
$disksClient = new DisksClient();
// Prepare the request message.
$request = (new ListDisksRequest())
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $disksClient->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);
}
removeResourcePolicies
Removes resource policies from a disk.
The async variant is DisksClient::removeResourcePoliciesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\RemoveResourcePoliciesDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\DisksRemoveResourcePoliciesRequest;
use Google\Cloud\Compute\V1\RemoveResourcePoliciesDiskRequest;
use Google\Rpc\Status;
/**
* @param string $disk The disk name for this request.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function remove_resource_policies_sample(string $disk, string $project, string $zone): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$disksRemoveResourcePoliciesRequestResource = new DisksRemoveResourcePoliciesRequest();
$request = (new RemoveResourcePoliciesDiskRequest())
->setDisk($disk)
->setDisksRemoveResourcePoliciesRequestResource($disksRemoveResourcePoliciesRequestResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $disksClient->removeResourcePolicies($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
{
$disk = '[DISK]';
$project = '[PROJECT]';
$zone = '[ZONE]';
remove_resource_policies_sample($disk, $project, $zone);
}
resize
Resizes the specified persistent disk. You can only increase the size of the disk.
The async variant is DisksClient::resizeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ResizeDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\DisksResizeRequest;
use Google\Cloud\Compute\V1\ResizeDiskRequest;
use Google\Rpc\Status;
/**
* @param string $disk The name of the persistent disk.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function resize_sample(string $disk, string $project, string $zone): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$disksResizeRequestResource = new DisksResizeRequest();
$request = (new ResizeDiskRequest())
->setDisk($disk)
->setDisksResizeRequestResource($disksResizeRequestResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $disksClient->resize($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
{
$disk = '[DISK]';
$project = '[PROJECT]';
$zone = '[ZONE]';
resize_sample($disk, $project, $zone);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
The async variant is DisksClient::setIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetIamPolicyDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\Policy;
use Google\Cloud\Compute\V1\SetIamPolicyDiskRequest;
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.
$disksClient = new DisksClient();
// Prepare the request message.
$zoneSetPolicyRequestResource = new ZoneSetPolicyRequest();
$request = (new SetIamPolicyDiskRequest())
->setProject($project)
->setResource($resource)
->setZone($zone)
->setZoneSetPolicyRequestResource($zoneSetPolicyRequestResource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $disksClient->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);
}
setLabels
Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.
The async variant is DisksClient::setLabelsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetLabelsDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\SetLabelsDiskRequest;
use Google\Cloud\Compute\V1\ZoneSetLabelsRequest;
use Google\Rpc\Status;
/**
* @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_labels_sample(string $project, string $resource, string $zone): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$zoneSetLabelsRequestResource = new ZoneSetLabelsRequest();
$request = (new SetLabelsDiskRequest())
->setProject($project)
->setResource($resource)
->setZone($zone)
->setZoneSetLabelsRequestResource($zoneSetLabelsRequestResource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $disksClient->setLabels($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]';
$resource = '[RESOURCE]';
$zone = '[ZONE]';
set_labels_sample($project, $resource, $zone);
}
startAsyncReplication
Starts asynchronous replication. Must be invoked on the primary disk.
The async variant is DisksClient::startAsyncReplicationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\StartAsyncReplicationDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\DisksStartAsyncReplicationRequest;
use Google\Cloud\Compute\V1\StartAsyncReplicationDiskRequest;
use Google\Rpc\Status;
/**
* @param string $disk The name of the persistent disk.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function start_async_replication_sample(string $disk, string $project, string $zone): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$disksStartAsyncReplicationRequestResource = new DisksStartAsyncReplicationRequest();
$request = (new StartAsyncReplicationDiskRequest())
->setDisk($disk)
->setDisksStartAsyncReplicationRequestResource($disksStartAsyncReplicationRequestResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $disksClient->startAsyncReplication($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
{
$disk = '[DISK]';
$project = '[PROJECT]';
$zone = '[ZONE]';
start_async_replication_sample($disk, $project, $zone);
}
stopAsyncReplication
Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.
The async variant is DisksClient::stopAsyncReplicationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\StopAsyncReplicationDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\StopAsyncReplicationDiskRequest;
use Google\Rpc\Status;
/**
* @param string $disk The name of the persistent disk.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function stop_async_replication_sample(string $disk, string $project, string $zone): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$request = (new StopAsyncReplicationDiskRequest())
->setDisk($disk)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $disksClient->stopAsyncReplication($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
{
$disk = '[DISK]';
$project = '[PROJECT]';
$zone = '[ZONE]';
stop_async_replication_sample($disk, $project, $zone);
}
stopGroupAsyncReplication
Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.
The async variant is DisksClient::stopGroupAsyncReplicationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\StopGroupAsyncReplicationDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\DisksStopGroupAsyncReplicationResource;
use Google\Cloud\Compute\V1\StopGroupAsyncReplicationDiskRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request. This must be the zone of the primary or secondary disks in the consistency group.
*/
function stop_group_async_replication_sample(string $project, string $zone): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$disksStopGroupAsyncReplicationResourceResource = new DisksStopGroupAsyncReplicationResource();
$request = (new StopGroupAsyncReplicationDiskRequest())
->setDisksStopGroupAsyncReplicationResourceResource($disksStopGroupAsyncReplicationResourceResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $disksClient->stopGroupAsyncReplication($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]';
stop_group_async_replication_sample($project, $zone);
}
testIamPermissions
Returns permissions that a caller has on the specified resource.
The async variant is DisksClient::testIamPermissionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\TestIamPermissionsDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\TestIamPermissionsDiskRequest;
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.
$disksClient = new DisksClient();
// Prepare the request message.
$testPermissionsRequestResource = new TestPermissionsRequest();
$request = (new TestIamPermissionsDiskRequest())
->setProject($project)
->setResource($resource)
->setTestPermissionsRequestResource($testPermissionsRequestResource)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var TestPermissionsResponse $response */
$response = $disksClient->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);
}
update
Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.
The async variant is DisksClient::updateAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\UpdateDiskRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\DisksClient;
use Google\Cloud\Compute\V1\Disk;
use Google\Cloud\Compute\V1\UpdateDiskRequest;
use Google\Rpc\Status;
/**
* @param string $disk The disk name for this request.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function update_sample(string $disk, string $project, string $zone): void
{
// Create a client.
$disksClient = new DisksClient();
// Prepare the request message.
$diskResource = new Disk();
$request = (new UpdateDiskRequest())
->setDisk($disk)
->setDiskResource($diskResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $disksClient->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
{
$disk = '[DISK]';
$project = '[PROJECT]';
$zone = '[ZONE]';
update_sample($disk, $project, $zone);
}
addResourcePoliciesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AddResourcePoliciesDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
aggregatedListAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AggregatedListDisksRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
bulkInsertAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\BulkInsertDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
createSnapshotAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\CreateSnapshotDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
deleteAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Disk> |
getIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetIamPolicyDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Policy> |
insertAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
listAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListDisksRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
removeResourcePoliciesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\RemoveResourcePoliciesDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
resizeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ResizeDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetIamPolicyDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Policy> |
setLabelsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetLabelsDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
startAsyncReplicationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\StartAsyncReplicationDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
stopAsyncReplicationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\StopAsyncReplicationDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
stopGroupAsyncReplicationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\StopGroupAsyncReplicationDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\TestIamPermissionsDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\TestPermissionsResponse> |
updateAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\UpdateDiskRequest
|
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 |
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 | |
---|---|
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 |