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.
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 regional 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\RegionDisksClient::addResourcePoliciesAsync() .
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.
bulkInsert
Bulk create a set of disks.
The async variant is Google\Cloud\Compute\V1\Client\RegionDisksClient::bulkInsertAsync() .
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.
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\RegionDisksClient::createSnapshotAsync() .
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.
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 Google\Cloud\Compute\V1\Client\RegionDisksClient::deleteAsync() .
request
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.
get
Returns a specified regional persistent disk.
The async variant is Google\Cloud\Compute\V1\Client\RegionDisksClient::getAsync() .
request
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.
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\RegionDisksClient::getIamPolicyAsync() .
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.
insert
Creates a persistent regional disk in the specified project using the data included in the request.
The async variant is Google\Cloud\Compute\V1\Client\RegionDisksClient::insertAsync() .
request
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.
list
Retrieves the list of persistent disks contained within the specified region.
The async variant is Google\Cloud\Compute\V1\Client\RegionDisksClient::listAsync() .
request
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.
removeResourcePolicies
Removes resource policies from a regional disk.
The async variant is Google\Cloud\Compute\V1\Client\RegionDisksClient::removeResourcePoliciesAsync() .
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.
resize
Resizes the specified regional persistent disk.
The async variant is Google\Cloud\Compute\V1\Client\RegionDisksClient::resizeAsync() .
request
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.
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
The async variant is Google\Cloud\Compute\V1\Client\RegionDisksClient::setIamPolicyAsync() .
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.
setLabels
Sets the labels on the target regional disk.
The async variant is Google\Cloud\Compute\V1\Client\RegionDisksClient::setLabelsAsync() .
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.
startAsyncReplication
Starts asynchronous replication. Must be invoked on the primary disk.
The async variant is Google\Cloud\Compute\V1\Client\RegionDisksClient::startAsyncReplicationAsync() .
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.
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\RegionDisksClient::stopAsyncReplicationAsync() .
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.
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\RegionDisksClient::stopGroupAsyncReplicationAsync() .
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.
testIamPermissions
Returns permissions that a caller has on the specified resource.
The async variant is Google\Cloud\Compute\V1\Client\RegionDisksClient::testIamPermissionsAsync() .
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.
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 Google\Cloud\Compute\V1\Client\RegionDisksClient::updateAsync() .
request
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.
addResourcePoliciesAsync
optionalArgs
array
bulkInsertAsync
optionalArgs
array
createSnapshotAsync
optionalArgs
array
deleteAsync
optionalArgs
array
getAsync
getIamPolicyAsync
optionalArgs
array
insertAsync
optionalArgs
array
listAsync
optionalArgs
array
removeResourcePoliciesAsync
optionalArgs
array
resizeAsync
optionalArgs
array
setIamPolicyAsync
optionalArgs
array
setLabelsAsync
optionalArgs
array
startAsyncReplicationAsync
optionalArgs
array
stopAsyncReplicationAsync
optionalArgs
array
stopGroupAsyncReplicationAsync
optionalArgs
array
testIamPermissionsAsync
optionalArgs
array
updateAsync
optionalArgs
array
getOperationsClient
Return an RegionOperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
