Compute V1 Client - Class DisksClient (1.12.1)

Version 1.12.1

• 1.21.0 (latest)
• 1.20.0
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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.

This class is currently experimental and may be subject to changes. See Google\Cloud\Compute\V1\DisksClient for the stable implementation

Namespace

Google \ Cloud \ Compute \ V1 \ Client

Methods

__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 false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. At the moment, supports only rest. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

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 Google\Cloud\Compute\V1\Client\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

aggregatedList

Retrieves an aggregated list of persistent disks.

The async variant is Google\Cloud\Compute\V1\Client\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

bulkInsert

Bulk create a set of disks.

The async variant is Google\Cloud\Compute\V1\Client\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

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 Google\Cloud\Compute\V1\Client\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

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 Google\Cloud\Compute\V1\Client\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

get

Returns the specified persistent disk.

The async variant is Google\Cloud\Compute\V1\Client\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

getIamPolicy

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

The async variant is Google\Cloud\Compute\V1\Client\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

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 Google\Cloud\Compute\V1\Client\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

list

Retrieves a list of persistent disks contained within the specified zone.

The async variant is Google\Cloud\Compute\V1\Client\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

removeResourcePolicies

Removes resource policies from a disk.

The async variant is Google\Cloud\Compute\V1\Client\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

resize

Resizes the specified persistent disk. You can only increase the size of the disk.

The async variant is Google\Cloud\Compute\V1\Client\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

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

The async variant is Google\Cloud\Compute\V1\Client\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

setLabels

Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.

The async variant is Google\Cloud\Compute\V1\Client\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

startAsyncReplication

Starts asynchronous replication. Must be invoked on the primary disk.

The async variant is Google\Cloud\Compute\V1\Client\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

stopAsyncReplication

Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.

The async variant is Google\Cloud\Compute\V1\Client\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

stopGroupAsyncReplication

Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.

The async variant is Google\Cloud\Compute\V1\Client\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

testIamPermissions

Returns permissions that a caller has on the specified resource.

The async variant is Google\Cloud\Compute\V1\Client\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

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 Google\Cloud\Compute\V1\Client\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

addResourcePoliciesAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\AddResourcePoliciesDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

aggregatedListAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\AggregatedListDisksRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

bulkInsertAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\BulkInsertDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createSnapshotAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\CreateSnapshotDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\DeleteDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetIamPolicyDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

insertAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\InsertDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\ListDisksRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

removeResourcePoliciesAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\RemoveResourcePoliciesDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

resizeAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\ResizeDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\SetIamPolicyDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setLabelsAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\SetLabelsDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

startAsyncReplicationAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\StartAsyncReplicationDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

stopAsyncReplicationAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\StopAsyncReplicationDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

stopGroupAsyncReplicationAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\StopGroupAsyncReplicationDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

testIamPermissionsAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\TestIamPermissionsDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\UpdateDiskRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

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