Compute Engine v1 API - Class RegionDisksClientImpl (2.17.0)

public sealed class RegionDisksClientImpl : RegionDisksClient

Reference documentation and code samples for the Compute Engine v1 API class RegionDisksClientImpl.

RegionDisks client wrapper implementation, for convenient use.

Inheritance

object > RegionDisksClient > RegionDisksClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The RegionDisks API.

Constructors

RegionDisksClientImpl(RegionDisksClient, RegionDisksSettings, ILogger)

public RegionDisksClientImpl(RegionDisks.RegionDisksClient grpcClient, RegionDisksSettings settings, ILogger logger)

Constructs a client wrapper for the RegionDisks service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient RegionDisksRegionDisksClient

The underlying gRPC client.

settings RegionDisksSettings

The base RegionDisksSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

AddResourcePoliciesOperationsClient

public override OperationsClient AddResourcePoliciesOperationsClient { get; }

The long-running operations client for AddResourcePolicies.

Property Value
Type Description
OperationsClient
Overrides

BulkInsertOperationsClient

public override OperationsClient BulkInsertOperationsClient { get; }

The long-running operations client for BulkInsert.

Property Value
Type Description
OperationsClient
Overrides

CreateSnapshotOperationsClient

public override OperationsClient CreateSnapshotOperationsClient { get; }

The long-running operations client for CreateSnapshot.

Property Value
Type Description
OperationsClient
Overrides

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override RegionDisks.RegionDisksClient GrpcClient { get; }

The underlying gRPC RegionDisks client

Property Value
Type Description
RegionDisksRegionDisksClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient
Overrides

RemoveResourcePoliciesOperationsClient

public override OperationsClient RemoveResourcePoliciesOperationsClient { get; }

The long-running operations client for RemoveResourcePolicies.

Property Value
Type Description
OperationsClient
Overrides

ResizeOperationsClient

public override OperationsClient ResizeOperationsClient { get; }

The long-running operations client for Resize.

Property Value
Type Description
OperationsClient
Overrides

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type Description
OperationsClient
Overrides

StartAsyncReplicationOperationsClient

public override OperationsClient StartAsyncReplicationOperationsClient { get; }

The long-running operations client for StartAsyncReplication.

Property Value
Type Description
OperationsClient
Overrides

StopAsyncReplicationOperationsClient

public override OperationsClient StopAsyncReplicationOperationsClient { get; }

The long-running operations client for StopAsyncReplication.

Property Value
Type Description
OperationsClient
Overrides

StopGroupAsyncReplicationOperationsClient

public override OperationsClient StopGroupAsyncReplicationOperationsClient { get; }

The long-running operations client for StopGroupAsyncReplication.

Property Value
Type Description
OperationsClient
Overrides

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
Type Description
OperationsClient
Overrides

Methods

AddResourcePolicies(AddResourcePoliciesRegionDiskRequest, CallSettings)

public override Operation<Operation, Operation> AddResourcePolicies(AddResourcePoliciesRegionDiskRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request AddResourcePoliciesRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

AddResourcePoliciesAsync(AddResourcePoliciesRegionDiskRequest, CallSettings)

public override Task<Operation<Operation, Operation>> AddResourcePoliciesAsync(AddResourcePoliciesRegionDiskRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request AddResourcePoliciesRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

BulkInsert(BulkInsertRegionDiskRequest, CallSettings)

public override Operation<Operation, Operation> BulkInsert(BulkInsertRegionDiskRequest request, CallSettings callSettings = null)

Bulk create a set of disks.

Parameters
Name Description
request BulkInsertRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

BulkInsertAsync(BulkInsertRegionDiskRequest, CallSettings)

public override Task<Operation<Operation, Operation>> BulkInsertAsync(BulkInsertRegionDiskRequest request, CallSettings callSettings = null)

Bulk create a set of disks.

Parameters
Name Description
request BulkInsertRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

CreateSnapshot(CreateSnapshotRegionDiskRequest, CallSettings)

public override Operation<Operation, Operation> CreateSnapshot(CreateSnapshotRegionDiskRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request CreateSnapshotRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

CreateSnapshotAsync(CreateSnapshotRegionDiskRequest, CallSettings)

public override Task<Operation<Operation, Operation>> CreateSnapshotAsync(CreateSnapshotRegionDiskRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request CreateSnapshotRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

Delete(DeleteRegionDiskRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteRegionDiskRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request DeleteRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

DeleteAsync(DeleteRegionDiskRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteRegionDiskRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request DeleteRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

Get(GetRegionDiskRequest, CallSettings)

public override Disk Get(GetRegionDiskRequest request, CallSettings callSettings = null)

Returns a specified regional persistent disk.

Parameters
Name Description
request GetRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Disk

The RPC response.

Overrides

GetAsync(GetRegionDiskRequest, CallSettings)

public override Task<Disk> GetAsync(GetRegionDiskRequest request, CallSettings callSettings = null)

Returns a specified regional persistent disk.

Parameters
Name Description
request GetRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDisk

A Task containing the RPC response.

Overrides

GetIamPolicy(GetIamPolicyRegionDiskRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRegionDiskRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetIamPolicyRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Overrides

GetIamPolicyAsync(GetIamPolicyRegionDiskRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRegionDiskRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetIamPolicyRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Overrides

Insert(InsertRegionDiskRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertRegionDiskRequest request, CallSettings callSettings = null)

Creates a persistent regional disk in the specified project using the data included in the request.

Parameters
Name Description
request InsertRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

InsertAsync(InsertRegionDiskRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InsertAsync(InsertRegionDiskRequest request, CallSettings callSettings = null)

Creates a persistent regional disk in the specified project using the data included in the request.

Parameters
Name Description
request InsertRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

List(ListRegionDisksRequest, CallSettings)

public override PagedEnumerable<DiskList, Disk> List(ListRegionDisksRequest request, CallSettings callSettings = null)

Retrieves the list of persistent disks contained within the specified region.

Parameters
Name Description
request ListRegionDisksRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableDiskListDisk

A pageable sequence of Disk resources.

Overrides

ListAsync(ListRegionDisksRequest, CallSettings)

public override PagedAsyncEnumerable<DiskList, Disk> ListAsync(ListRegionDisksRequest request, CallSettings callSettings = null)

Retrieves the list of persistent disks contained within the specified region.

Parameters
Name Description
request ListRegionDisksRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableDiskListDisk

A pageable asynchronous sequence of Disk resources.

Overrides

RemoveResourcePolicies(RemoveResourcePoliciesRegionDiskRequest, CallSettings)

public override Operation<Operation, Operation> RemoveResourcePolicies(RemoveResourcePoliciesRegionDiskRequest request, CallSettings callSettings = null)

Removes resource policies from a regional disk.

Parameters
Name Description
request RemoveResourcePoliciesRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

RemoveResourcePoliciesAsync(RemoveResourcePoliciesRegionDiskRequest, CallSettings)

public override Task<Operation<Operation, Operation>> RemoveResourcePoliciesAsync(RemoveResourcePoliciesRegionDiskRequest request, CallSettings callSettings = null)

Removes resource policies from a regional disk.

Parameters
Name Description
request RemoveResourcePoliciesRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

Resize(ResizeRegionDiskRequest, CallSettings)

public override Operation<Operation, Operation> Resize(ResizeRegionDiskRequest request, CallSettings callSettings = null)

Resizes the specified regional persistent disk.

Parameters
Name Description
request ResizeRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

ResizeAsync(ResizeRegionDiskRequest, CallSettings)

public override Task<Operation<Operation, Operation>> ResizeAsync(ResizeRegionDiskRequest request, CallSettings callSettings = null)

Resizes the specified regional persistent disk.

Parameters
Name Description
request ResizeRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

SetIamPolicy(SetIamPolicyRegionDiskRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRegionDiskRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SetIamPolicyRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Overrides

SetIamPolicyAsync(SetIamPolicyRegionDiskRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRegionDiskRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SetIamPolicyRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Overrides

SetLabels(SetLabelsRegionDiskRequest, CallSettings)

public override Operation<Operation, Operation> SetLabels(SetLabelsRegionDiskRequest request, CallSettings callSettings = null)

Sets the labels on the target regional disk.

Parameters
Name Description
request SetLabelsRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

SetLabelsAsync(SetLabelsRegionDiskRequest, CallSettings)

public override Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsRegionDiskRequest request, CallSettings callSettings = null)

Sets the labels on the target regional disk.

Parameters
Name Description
request SetLabelsRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

StartAsyncReplication(StartAsyncReplicationRegionDiskRequest, CallSettings)

public override Operation<Operation, Operation> StartAsyncReplication(StartAsyncReplicationRegionDiskRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request StartAsyncReplicationRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

StartAsyncReplicationAsync(StartAsyncReplicationRegionDiskRequest, CallSettings)

public override Task<Operation<Operation, Operation>> StartAsyncReplicationAsync(StartAsyncReplicationRegionDiskRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request StartAsyncReplicationRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

StopAsyncReplication(StopAsyncReplicationRegionDiskRequest, CallSettings)

public override Operation<Operation, Operation> StopAsyncReplication(StopAsyncReplicationRegionDiskRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request StopAsyncReplicationRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

StopAsyncReplicationAsync(StopAsyncReplicationRegionDiskRequest, CallSettings)

public override Task<Operation<Operation, Operation>> StopAsyncReplicationAsync(StopAsyncReplicationRegionDiskRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request StopAsyncReplicationRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

StopGroupAsyncReplication(StopGroupAsyncReplicationRegionDiskRequest, CallSettings)

public override Operation<Operation, Operation> StopGroupAsyncReplication(StopGroupAsyncReplicationRegionDiskRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request StopGroupAsyncReplicationRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

StopGroupAsyncReplicationAsync(StopGroupAsyncReplicationRegionDiskRequest, CallSettings)

public override Task<Operation<Operation, Operation>> StopGroupAsyncReplicationAsync(StopGroupAsyncReplicationRegionDiskRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request StopGroupAsyncReplicationRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

TestIamPermissions(TestIamPermissionsRegionDiskRequest, CallSettings)

public override TestPermissionsResponse TestIamPermissions(TestIamPermissionsRegionDiskRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TestPermissionsResponse

The RPC response.

Overrides

TestIamPermissionsAsync(TestIamPermissionsRegionDiskRequest, CallSettings)

public override Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRegionDiskRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTestPermissionsResponse

A Task containing the RPC response.

Overrides

Update(UpdateRegionDiskRequest, CallSettings)

public override Operation<Operation, Operation> Update(UpdateRegionDiskRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request UpdateRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

UpdateAsync(UpdateRegionDiskRequest, CallSettings)

public override Task<Operation<Operation, Operation>> UpdateAsync(UpdateRegionDiskRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request UpdateRegionDiskRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides