public class Disks.DisksClient : ClientBase<Disks.DisksClient>
Reference documentation and code samples for the Compute Engine v1 API class Disks.DisksClient.
Client for Disks
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Constructors
DisksClient()
protected DisksClient()
Protected parameterless constructor to allow creation of test doubles.
DisksClient(CallInvoker)
public DisksClient(CallInvoker callInvoker)
Creates a new client for Disks that uses a custom CallInvoker
.
Parameter | |
---|---|
Name | Description |
callInvoker |
CallInvoker The callInvoker to use to make remote calls. |
DisksClient(ChannelBase)
public DisksClient(ChannelBase channel)
Creates a new client for Disks
Parameter | |
---|---|
Name | Description |
channel |
ChannelBase The channel to use to make remote calls. |
DisksClient(ClientBaseConfiguration)
protected DisksClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration The client configuration. |
Methods
AddResourcePolicies(AddResourcePoliciesDiskRequest, CallOptions)
public virtual Operation AddResourcePolicies(AddResourcePoliciesDiskRequest request, CallOptions options)
Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.
Parameters | |
---|---|
Name | Description |
request |
AddResourcePoliciesDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
AddResourcePolicies(AddResourcePoliciesDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation AddResourcePolicies(AddResourcePoliciesDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.
Parameters | |
---|---|
Name | Description |
request |
AddResourcePoliciesDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
AddResourcePoliciesAsync(AddResourcePoliciesDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> AddResourcePoliciesAsync(AddResourcePoliciesDiskRequest request, CallOptions options)
Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.
Parameters | |
---|---|
Name | Description |
request |
AddResourcePoliciesDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
AddResourcePoliciesAsync(AddResourcePoliciesDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> AddResourcePoliciesAsync(AddResourcePoliciesDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.
Parameters | |
---|---|
Name | Description |
request |
AddResourcePoliciesDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
AggregatedList(AggregatedListDisksRequest, CallOptions)
public virtual DiskAggregatedList AggregatedList(AggregatedListDisksRequest request, CallOptions options)
Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
Parameters | |
---|---|
Name | Description |
request |
AggregatedListDisksRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
DiskAggregatedList |
The response received from the server. |
AggregatedList(AggregatedListDisksRequest, Metadata, DateTime?, CancellationToken)
public virtual DiskAggregatedList AggregatedList(AggregatedListDisksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
Parameters | |
---|---|
Name | Description |
request |
AggregatedListDisksRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
DiskAggregatedList |
The response received from the server. |
AggregatedListAsync(AggregatedListDisksRequest, CallOptions)
public virtual AsyncUnaryCall<DiskAggregatedList> AggregatedListAsync(AggregatedListDisksRequest request, CallOptions options)
Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
Parameters | |
---|---|
Name | Description |
request |
AggregatedListDisksRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDiskAggregatedList |
The call object. |
AggregatedListAsync(AggregatedListDisksRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<DiskAggregatedList> AggregatedListAsync(AggregatedListDisksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
Parameters | |
---|---|
Name | Description |
request |
AggregatedListDisksRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDiskAggregatedList |
The call object. |
BulkInsert(BulkInsertDiskRequest, CallOptions)
public virtual Operation BulkInsert(BulkInsertDiskRequest request, CallOptions options)
Bulk create a set of disks.
Parameters | |
---|---|
Name | Description |
request |
BulkInsertDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
BulkInsert(BulkInsertDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation BulkInsert(BulkInsertDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Bulk create a set of disks.
Parameters | |
---|---|
Name | Description |
request |
BulkInsertDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
BulkInsertAsync(BulkInsertDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> BulkInsertAsync(BulkInsertDiskRequest request, CallOptions options)
Bulk create a set of disks.
Parameters | |
---|---|
Name | Description |
request |
BulkInsertDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
BulkInsertAsync(BulkInsertDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> BulkInsertAsync(BulkInsertDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Bulk create a set of disks.
Parameters | |
---|---|
Name | Description |
request |
BulkInsertDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateOperationsClientForZoneOperations()
public virtual Operations.OperationsClient CreateOperationsClientForZoneOperations()
Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to ZoneOperations.
Returns | |
---|---|
Type | Description |
OperationsOperationsClient |
A new Operations client for the same target as this client. |
CreateSnapshot(CreateSnapshotDiskRequest, CallOptions)
public virtual Operation CreateSnapshot(CreateSnapshotDiskRequest request, CallOptions options)
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 |
CreateSnapshotDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
CreateSnapshot(CreateSnapshotDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateSnapshot(CreateSnapshotDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
CreateSnapshotDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
CreateSnapshotAsync(CreateSnapshotDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateSnapshotAsync(CreateSnapshotDiskRequest request, CallOptions options)
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 |
CreateSnapshotDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateSnapshotAsync(CreateSnapshotDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateSnapshotAsync(CreateSnapshotDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
CreateSnapshotDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
Delete(DeleteDiskRequest, CallOptions)
public virtual Operation Delete(DeleteDiskRequest request, CallOptions options)
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.
Parameters | |
---|---|
Name | Description |
request |
DeleteDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
Delete(DeleteDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation Delete(DeleteDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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.
Parameters | |
---|---|
Name | Description |
request |
DeleteDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
DeleteAsync(DeleteDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteDiskRequest request, CallOptions options)
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.
Parameters | |
---|---|
Name | Description |
request |
DeleteDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteAsync(DeleteDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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.
Parameters | |
---|---|
Name | Description |
request |
DeleteDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
Get(GetDiskRequest, CallOptions)
public virtual Disk Get(GetDiskRequest request, CallOptions options)
Returns the specified persistent disk.
Parameters | |
---|---|
Name | Description |
request |
GetDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Disk |
The response received from the server. |
Get(GetDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Disk Get(GetDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the specified persistent disk.
Parameters | |
---|---|
Name | Description |
request |
GetDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Disk |
The response received from the server. |
GetAsync(GetDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Disk> GetAsync(GetDiskRequest request, CallOptions options)
Returns the specified persistent disk.
Parameters | |
---|---|
Name | Description |
request |
GetDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDisk |
The call object. |
GetAsync(GetDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Disk> GetAsync(GetDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the specified persistent disk.
Parameters | |
---|---|
Name | Description |
request |
GetDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDisk |
The call object. |
GetIamPolicy(GetIamPolicyDiskRequest, CallOptions)
public virtual Policy GetIamPolicy(GetIamPolicyDiskRequest request, CallOptions options)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameters | |
---|---|
Name | Description |
request |
GetIamPolicyDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Policy |
The response received from the server. |
GetIamPolicy(GetIamPolicyDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Policy GetIamPolicy(GetIamPolicyDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameters | |
---|---|
Name | Description |
request |
GetIamPolicyDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Policy |
The response received from the server. |
GetIamPolicyAsync(GetIamPolicyDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyDiskRequest request, CallOptions options)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameters | |
---|---|
Name | Description |
request |
GetIamPolicyDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPolicy |
The call object. |
GetIamPolicyAsync(GetIamPolicyDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameters | |
---|---|
Name | Description |
request |
GetIamPolicyDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPolicy |
The call object. |
Insert(InsertDiskRequest, CallOptions)
public virtual Operation Insert(InsertDiskRequest request, CallOptions options)
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.
Parameters | |
---|---|
Name | Description |
request |
InsertDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
Insert(InsertDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation Insert(InsertDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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.
Parameters | |
---|---|
Name | Description |
request |
InsertDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
InsertAsync(InsertDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> InsertAsync(InsertDiskRequest request, CallOptions options)
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.
Parameters | |
---|---|
Name | Description |
request |
InsertDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
InsertAsync(InsertDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> InsertAsync(InsertDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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.
Parameters | |
---|---|
Name | Description |
request |
InsertDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
List(ListDisksRequest, CallOptions)
public virtual DiskList List(ListDisksRequest request, CallOptions options)
Retrieves a list of persistent disks contained within the specified zone.
Parameters | |
---|---|
Name | Description |
request |
ListDisksRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
DiskList |
The response received from the server. |
List(ListDisksRequest, Metadata, DateTime?, CancellationToken)
public virtual DiskList List(ListDisksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Retrieves a list of persistent disks contained within the specified zone.
Parameters | |
---|---|
Name | Description |
request |
ListDisksRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
DiskList |
The response received from the server. |
ListAsync(ListDisksRequest, CallOptions)
public virtual AsyncUnaryCall<DiskList> ListAsync(ListDisksRequest request, CallOptions options)
Retrieves a list of persistent disks contained within the specified zone.
Parameters | |
---|---|
Name | Description |
request |
ListDisksRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDiskList |
The call object. |
ListAsync(ListDisksRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<DiskList> ListAsync(ListDisksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Retrieves a list of persistent disks contained within the specified zone.
Parameters | |
---|---|
Name | Description |
request |
ListDisksRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallDiskList |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override Disks.DisksClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
DisksDisksClient |
RemoveResourcePolicies(RemoveResourcePoliciesDiskRequest, CallOptions)
public virtual Operation RemoveResourcePolicies(RemoveResourcePoliciesDiskRequest request, CallOptions options)
Removes resource policies from a disk.
Parameters | |
---|---|
Name | Description |
request |
RemoveResourcePoliciesDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
RemoveResourcePolicies(RemoveResourcePoliciesDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation RemoveResourcePolicies(RemoveResourcePoliciesDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Removes resource policies from a disk.
Parameters | |
---|---|
Name | Description |
request |
RemoveResourcePoliciesDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
RemoveResourcePoliciesAsync(RemoveResourcePoliciesDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> RemoveResourcePoliciesAsync(RemoveResourcePoliciesDiskRequest request, CallOptions options)
Removes resource policies from a disk.
Parameters | |
---|---|
Name | Description |
request |
RemoveResourcePoliciesDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
RemoveResourcePoliciesAsync(RemoveResourcePoliciesDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> RemoveResourcePoliciesAsync(RemoveResourcePoliciesDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Removes resource policies from a disk.
Parameters | |
---|---|
Name | Description |
request |
RemoveResourcePoliciesDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
Resize(ResizeDiskRequest, CallOptions)
public virtual Operation Resize(ResizeDiskRequest request, CallOptions options)
Resizes the specified persistent disk. You can only increase the size of the disk.
Parameters | |
---|---|
Name | Description |
request |
ResizeDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
Resize(ResizeDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation Resize(ResizeDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Resizes the specified persistent disk. You can only increase the size of the disk.
Parameters | |
---|---|
Name | Description |
request |
ResizeDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
ResizeAsync(ResizeDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> ResizeAsync(ResizeDiskRequest request, CallOptions options)
Resizes the specified persistent disk. You can only increase the size of the disk.
Parameters | |
---|---|
Name | Description |
request |
ResizeDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
ResizeAsync(ResizeDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> ResizeAsync(ResizeDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Resizes the specified persistent disk. You can only increase the size of the disk.
Parameters | |
---|---|
Name | Description |
request |
ResizeDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
SetIamPolicy(SetIamPolicyDiskRequest, CallOptions)
public virtual Policy SetIamPolicy(SetIamPolicyDiskRequest request, CallOptions options)
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
request |
SetIamPolicyDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Policy |
The response received from the server. |
SetIamPolicy(SetIamPolicyDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Policy SetIamPolicy(SetIamPolicyDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
request |
SetIamPolicyDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Policy |
The response received from the server. |
SetIamPolicyAsync(SetIamPolicyDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyDiskRequest request, CallOptions options)
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
request |
SetIamPolicyDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPolicy |
The call object. |
SetIamPolicyAsync(SetIamPolicyDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
request |
SetIamPolicyDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPolicy |
The call object. |
SetLabels(SetLabelsDiskRequest, CallOptions)
public virtual Operation SetLabels(SetLabelsDiskRequest request, CallOptions options)
Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.
Parameters | |
---|---|
Name | Description |
request |
SetLabelsDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
SetLabels(SetLabelsDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation SetLabels(SetLabelsDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.
Parameters | |
---|---|
Name | Description |
request |
SetLabelsDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
SetLabelsAsync(SetLabelsDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsDiskRequest request, CallOptions options)
Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.
Parameters | |
---|---|
Name | Description |
request |
SetLabelsDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
SetLabelsAsync(SetLabelsDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.
Parameters | |
---|---|
Name | Description |
request |
SetLabelsDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
StartAsyncReplication(StartAsyncReplicationDiskRequest, CallOptions)
public virtual Operation StartAsyncReplication(StartAsyncReplicationDiskRequest request, CallOptions options)
Starts asynchronous replication. Must be invoked on the primary disk.
Parameters | |
---|---|
Name | Description |
request |
StartAsyncReplicationDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
StartAsyncReplication(StartAsyncReplicationDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation StartAsyncReplication(StartAsyncReplicationDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Starts asynchronous replication. Must be invoked on the primary disk.
Parameters | |
---|---|
Name | Description |
request |
StartAsyncReplicationDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
StartAsyncReplicationAsync(StartAsyncReplicationDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> StartAsyncReplicationAsync(StartAsyncReplicationDiskRequest request, CallOptions options)
Starts asynchronous replication. Must be invoked on the primary disk.
Parameters | |
---|---|
Name | Description |
request |
StartAsyncReplicationDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
StartAsyncReplicationAsync(StartAsyncReplicationDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> StartAsyncReplicationAsync(StartAsyncReplicationDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Starts asynchronous replication. Must be invoked on the primary disk.
Parameters | |
---|---|
Name | Description |
request |
StartAsyncReplicationDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
StopAsyncReplication(StopAsyncReplicationDiskRequest, CallOptions)
public virtual Operation StopAsyncReplication(StopAsyncReplicationDiskRequest request, CallOptions options)
Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.
Parameters | |
---|---|
Name | Description |
request |
StopAsyncReplicationDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
StopAsyncReplication(StopAsyncReplicationDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation StopAsyncReplication(StopAsyncReplicationDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.
Parameters | |
---|---|
Name | Description |
request |
StopAsyncReplicationDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
StopAsyncReplicationAsync(StopAsyncReplicationDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> StopAsyncReplicationAsync(StopAsyncReplicationDiskRequest request, CallOptions options)
Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.
Parameters | |
---|---|
Name | Description |
request |
StopAsyncReplicationDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
StopAsyncReplicationAsync(StopAsyncReplicationDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> StopAsyncReplicationAsync(StopAsyncReplicationDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.
Parameters | |
---|---|
Name | Description |
request |
StopAsyncReplicationDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
StopGroupAsyncReplication(StopGroupAsyncReplicationDiskRequest, CallOptions)
public virtual Operation StopGroupAsyncReplication(StopGroupAsyncReplicationDiskRequest request, CallOptions options)
Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.
Parameters | |
---|---|
Name | Description |
request |
StopGroupAsyncReplicationDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
StopGroupAsyncReplication(StopGroupAsyncReplicationDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation StopGroupAsyncReplication(StopGroupAsyncReplicationDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.
Parameters | |
---|---|
Name | Description |
request |
StopGroupAsyncReplicationDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
StopGroupAsyncReplicationAsync(StopGroupAsyncReplicationDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> StopGroupAsyncReplicationAsync(StopGroupAsyncReplicationDiskRequest request, CallOptions options)
Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.
Parameters | |
---|---|
Name | Description |
request |
StopGroupAsyncReplicationDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
StopGroupAsyncReplicationAsync(StopGroupAsyncReplicationDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> StopGroupAsyncReplicationAsync(StopGroupAsyncReplicationDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.
Parameters | |
---|---|
Name | Description |
request |
StopGroupAsyncReplicationDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
TestIamPermissions(TestIamPermissionsDiskRequest, CallOptions)
public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsDiskRequest request, CallOptions options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
TestIamPermissionsDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
TestPermissionsResponse |
The response received from the server. |
TestIamPermissions(TestIamPermissionsDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
TestIamPermissionsDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
TestPermissionsResponse |
The response received from the server. |
TestIamPermissionsAsync(TestIamPermissionsDiskRequest, CallOptions)
public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsDiskRequest request, CallOptions options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
TestIamPermissionsDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallTestPermissionsResponse |
The call object. |
TestIamPermissionsAsync(TestIamPermissionsDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
TestIamPermissionsDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallTestPermissionsResponse |
The call object. |
Update(UpdateDiskRequest, CallOptions)
public virtual Operation Update(UpdateDiskRequest request, CallOptions options)
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.
Parameters | |
---|---|
Name | Description |
request |
UpdateDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
Update(UpdateDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation Update(UpdateDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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.
Parameters | |
---|---|
Name | Description |
request |
UpdateDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
UpdateAsync(UpdateDiskRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateDiskRequest request, CallOptions options)
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.
Parameters | |
---|---|
Name | Description |
request |
UpdateDiskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateAsync(UpdateDiskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateDiskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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.
Parameters | |
---|---|
Name | Description |
request |
UpdateDiskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |