Reference documentation and code samples for the Compute V1 Client class RegionDisksClient.
Service Description: The RegionDisks 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 regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.
The async variant is RegionDisksClient::addResourcePoliciesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AddResourcePoliciesRegionDiskRequest
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\AddResourcePoliciesRegionDiskRequest;
use Google\Cloud\Compute\V1\Client\RegionDisksClient;
use Google\Cloud\Compute\V1\RegionDisksAddResourcePoliciesRequest;
use Google\Rpc\Status;
/**
* @param string $disk The disk name for this request.
* @param string $project Project ID for this request.
* @param string $region The name of the region for this request.
*/
function add_resource_policies_sample(string $disk, string $project, string $region): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$regionDisksAddResourcePoliciesRequestResource = new RegionDisksAddResourcePoliciesRequest();
$request = (new AddResourcePoliciesRegionDiskRequest())
->setDisk($disk)
->setProject($project)
->setRegion($region)
->setRegionDisksAddResourcePoliciesRequestResource($regionDisksAddResourcePoliciesRequestResource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
add_resource_policies_sample($disk, $project, $region);
}
bulkInsert
Bulk create a set of disks.
The async variant is RegionDisksClient::bulkInsertAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\BulkInsertRegionDiskRequest
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\BulkInsertDiskResource;
use Google\Cloud\Compute\V1\BulkInsertRegionDiskRequest;
use Google\Cloud\Compute\V1\Client\RegionDisksClient;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region The name of the region for this request.
*/
function bulk_insert_sample(string $project, string $region): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$bulkInsertDiskResourceResource = new BulkInsertDiskResource();
$request = (new BulkInsertRegionDiskRequest())
->setBulkInsertDiskResourceResource($bulkInsertDiskResourceResource)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
bulk_insert_sample($project, $region);
}
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 RegionDisksClient::createSnapshotAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\CreateSnapshotRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\CreateSnapshotRegionDiskRequest;
use Google\Cloud\Compute\V1\Snapshot;
use Google\Rpc\Status;
/**
* @param string $disk Name of the regional persistent disk to snapshot.
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
*/
function create_snapshot_sample(string $disk, string $project, string $region): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$snapshotResource = new Snapshot();
$request = (new CreateSnapshotRegionDiskRequest())
->setDisk($disk)
->setProject($project)
->setRegion($region)
->setSnapshotResource($snapshotResource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
create_snapshot_sample($disk, $project, $region);
}
delete
Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of 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 RegionDisksClient::deleteAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\DeleteRegionDiskRequest;
use Google\Rpc\Status;
/**
* @param string $disk Name of the regional persistent disk to delete.
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
*/
function delete_sample(string $disk, string $project, string $region): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$request = (new DeleteRegionDiskRequest())
->setDisk($disk)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
delete_sample($disk, $project, $region);
}
get
Returns a specified regional persistent disk.
The async variant is RegionDisksClient::getAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\Disk;
use Google\Cloud\Compute\V1\GetRegionDiskRequest;
/**
* @param string $disk Name of the regional persistent disk to return.
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
*/
function get_sample(string $disk, string $project, string $region): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$request = (new GetRegionDiskRequest())
->setDisk($disk)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var Disk $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
get_sample($disk, $project, $region);
}
getIamPolicy
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
The async variant is RegionDisksClient::getIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetIamPolicyRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\GetIamPolicyRegionDiskRequest;
use Google\Cloud\Compute\V1\Policy;
/**
* @param string $project Project ID for this request.
* @param string $region The name of the region for this request.
* @param string $resource Name or id of the resource for this request.
*/
function get_iam_policy_sample(string $project, string $region, string $resource): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$request = (new GetIamPolicyRegionDiskRequest())
->setProject($project)
->setRegion($region)
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
$resource = '[RESOURCE]';
get_iam_policy_sample($project, $region, $resource);
}
insert
Creates a persistent regional disk in the specified project using the data included in the request.
The async variant is RegionDisksClient::insertAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\Disk;
use Google\Cloud\Compute\V1\InsertRegionDiskRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
*/
function insert_sample(string $project, string $region): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$diskResource = new Disk();
$request = (new InsertRegionDiskRequest())
->setDiskResource($diskResource)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
insert_sample($project, $region);
}
list
Retrieves the list of persistent disks contained within the specified region.
The async variant is RegionDisksClient::listAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListRegionDisksRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\ListRegionDisksRequest;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region for this request.
*/
function list_sample(string $project, string $region): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$request = (new ListRegionDisksRequest())
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
list_sample($project, $region);
}
removeResourcePolicies
Removes resource policies from a regional disk.
The async variant is RegionDisksClient::removeResourcePoliciesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\RemoveResourcePoliciesRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\RegionDisksRemoveResourcePoliciesRequest;
use Google\Cloud\Compute\V1\RemoveResourcePoliciesRegionDiskRequest;
use Google\Rpc\Status;
/**
* @param string $disk The disk name for this request.
* @param string $project Project ID for this request.
* @param string $region The name of the region for this request.
*/
function remove_resource_policies_sample(string $disk, string $project, string $region): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$regionDisksRemoveResourcePoliciesRequestResource = new RegionDisksRemoveResourcePoliciesRequest();
$request = (new RemoveResourcePoliciesRegionDiskRequest())
->setDisk($disk)
->setProject($project)
->setRegion($region)
->setRegionDisksRemoveResourcePoliciesRequestResource(
$regionDisksRemoveResourcePoliciesRequestResource
);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
remove_resource_policies_sample($disk, $project, $region);
}
resize
Resizes the specified regional persistent disk.
The async variant is RegionDisksClient::resizeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ResizeRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\RegionDisksResizeRequest;
use Google\Cloud\Compute\V1\ResizeRegionDiskRequest;
use Google\Rpc\Status;
/**
* @param string $disk Name of the regional persistent disk.
* @param string $project The project ID for this request.
* @param string $region Name of the region for this request.
*/
function resize_sample(string $disk, string $project, string $region): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$regionDisksResizeRequestResource = new RegionDisksResizeRequest();
$request = (new ResizeRegionDiskRequest())
->setDisk($disk)
->setProject($project)
->setRegion($region)
->setRegionDisksResizeRequestResource($regionDisksResizeRequestResource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
resize_sample($disk, $project, $region);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
The async variant is RegionDisksClient::setIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetIamPolicyRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\Policy;
use Google\Cloud\Compute\V1\RegionSetPolicyRequest;
use Google\Cloud\Compute\V1\SetIamPolicyRegionDiskRequest;
/**
* @param string $project Project ID for this request.
* @param string $region The name of the region for this request.
* @param string $resource Name or id of the resource for this request.
*/
function set_iam_policy_sample(string $project, string $region, string $resource): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$regionSetPolicyRequestResource = new RegionSetPolicyRequest();
$request = (new SetIamPolicyRegionDiskRequest())
->setProject($project)
->setRegion($region)
->setRegionSetPolicyRequestResource($regionSetPolicyRequestResource)
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
$resource = '[RESOURCE]';
set_iam_policy_sample($project, $region, $resource);
}
setLabels
Sets the labels on the target regional disk.
The async variant is RegionDisksClient::setLabelsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetLabelsRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\RegionSetLabelsRequest;
use Google\Cloud\Compute\V1\SetLabelsRegionDiskRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region The region for this request.
* @param string $resource Name or id of the resource for this request.
*/
function set_labels_sample(string $project, string $region, string $resource): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$regionSetLabelsRequestResource = new RegionSetLabelsRequest();
$request = (new SetLabelsRegionDiskRequest())
->setProject($project)
->setRegion($region)
->setRegionSetLabelsRequestResource($regionSetLabelsRequestResource)
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
$resource = '[RESOURCE]';
set_labels_sample($project, $region, $resource);
}
startAsyncReplication
Starts asynchronous replication. Must be invoked on the primary disk.
The async variant is RegionDisksClient::startAsyncReplicationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\StartAsyncReplicationRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\RegionDisksStartAsyncReplicationRequest;
use Google\Cloud\Compute\V1\StartAsyncReplicationRegionDiskRequest;
use Google\Rpc\Status;
/**
* @param string $disk The name of the persistent disk.
* @param string $project Project ID for this request.
* @param string $region The name of the region for this request.
*/
function start_async_replication_sample(string $disk, string $project, string $region): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$regionDisksStartAsyncReplicationRequestResource = new RegionDisksStartAsyncReplicationRequest();
$request = (new StartAsyncReplicationRegionDiskRequest())
->setDisk($disk)
->setProject($project)
->setRegion($region)
->setRegionDisksStartAsyncReplicationRequestResource(
$regionDisksStartAsyncReplicationRequestResource
);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
start_async_replication_sample($disk, $project, $region);
}
stopAsyncReplication
Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.
The async variant is RegionDisksClient::stopAsyncReplicationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\StopAsyncReplicationRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\StopAsyncReplicationRegionDiskRequest;
use Google\Rpc\Status;
/**
* @param string $disk The name of the persistent disk.
* @param string $project Project ID for this request.
* @param string $region The name of the region for this request.
*/
function stop_async_replication_sample(string $disk, string $project, string $region): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$request = (new StopAsyncReplicationRegionDiskRequest())
->setDisk($disk)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
stop_async_replication_sample($disk, $project, $region);
}
stopGroupAsyncReplication
Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.
The async variant is RegionDisksClient::stopGroupAsyncReplicationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\StopGroupAsyncReplicationRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\DisksStopGroupAsyncReplicationResource;
use Google\Cloud\Compute\V1\StopGroupAsyncReplicationRegionDiskRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region The name of the region for this request. This must be the region of the primary or secondary disks in the consistency group.
*/
function stop_group_async_replication_sample(string $project, string $region): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$disksStopGroupAsyncReplicationResourceResource = new DisksStopGroupAsyncReplicationResource();
$request = (new StopGroupAsyncReplicationRegionDiskRequest())
->setDisksStopGroupAsyncReplicationResourceResource($disksStopGroupAsyncReplicationResourceResource)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
stop_group_async_replication_sample($project, $region);
}
testIamPermissions
Returns permissions that a caller has on the specified resource.
The async variant is RegionDisksClient::testIamPermissionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\TestIamPermissionsRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\TestIamPermissionsRegionDiskRequest;
use Google\Cloud\Compute\V1\TestPermissionsRequest;
use Google\Cloud\Compute\V1\TestPermissionsResponse;
/**
* @param string $project Project ID for this request.
* @param string $region The name of the region for this request.
* @param string $resource Name or id of the resource for this request.
*/
function test_iam_permissions_sample(string $project, string $region, string $resource): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$testPermissionsRequestResource = new TestPermissionsRequest();
$request = (new TestIamPermissionsRegionDiskRequest())
->setProject($project)
->setRegion($region)
->setResource($resource)
->setTestPermissionsRequestResource($testPermissionsRequestResource);
// Call the API and handle any network failures.
try {
/** @var TestPermissionsResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
$resource = '[RESOURCE]';
test_iam_permissions_sample($project, $region, $resource);
}
update
Update the specified disk with the data included in the request. 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 RegionDisksClient::updateAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\UpdateRegionDiskRequest
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\RegionDisksClient;
use Google\Cloud\Compute\V1\Disk;
use Google\Cloud\Compute\V1\UpdateRegionDiskRequest;
use Google\Rpc\Status;
/**
* @param string $disk The disk name for this request.
* @param string $project Project ID for this request.
* @param string $region The name of the region for this request.
*/
function update_sample(string $disk, string $project, string $region): void
{
// Create a client.
$regionDisksClient = new RegionDisksClient();
// Prepare the request message.
$diskResource = new Disk();
$request = (new UpdateRegionDiskRequest())
->setDisk($disk)
->setDiskResource($diskResource)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionDisksClient->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]';
$region = '[REGION]';
update_sample($disk, $project, $region);
}
addResourcePoliciesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AddResourcePoliciesRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
bulkInsertAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\BulkInsertRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
createSnapshotAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\CreateSnapshotRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
deleteAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Disk> |
getIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetIamPolicyRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Policy> |
insertAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
listAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListRegionDisksRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
removeResourcePoliciesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\RemoveResourcePoliciesRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
resizeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ResizeRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetIamPolicyRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Policy> |
setLabelsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetLabelsRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
startAsyncReplicationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\StartAsyncReplicationRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
stopAsyncReplicationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\StopAsyncReplicationRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
stopGroupAsyncReplicationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\StopGroupAsyncReplicationRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\TestIamPermissionsRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\TestPermissionsResponse> |
updateAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\UpdateRegionDiskRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getOperationsClient
Return an RegionOperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\RegionOperationsClient |
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 |