public class RegionOperationsClient : ClientBase<RegionOperations.RegionOperationsClient>Reference documentation and code samples for the Compute Engine v1 API class RegionOperations.RegionOperationsClient.
Client for RegionOperations
Inheritance
Object > ClientBase > ClientBase<RegionOperations.RegionOperationsClient> > RegionOperations.RegionOperationsClientNamespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Constructors
RegionOperationsClient()
protected RegionOperationsClient()Protected parameterless constructor to allow creation of test doubles.
RegionOperationsClient(CallInvoker)
public RegionOperationsClient(CallInvoker callInvoker)Creates a new client for RegionOperations that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker | CallInvokerThe callInvoker to use to make remote calls. |
RegionOperationsClient(ChannelBase)
public RegionOperationsClient(ChannelBase channel)Creates a new client for RegionOperations
| Parameter | |
|---|---|
| Name | Description |
channel | ChannelBaseThe channel to use to make remote calls. |
RegionOperationsClient(ClientBase.ClientBaseConfiguration)
protected RegionOperationsClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBase.ClientBaseConfigurationThe client configuration. |
Methods
Delete(DeleteRegionOperationRequest, CallOptions)
public virtual DeleteRegionOperationResponse Delete(DeleteRegionOperationRequest request, CallOptions options)Deletes the specified region-specific Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteRegionOperationRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
DeleteRegionOperationResponse | The response received from the server. |
Delete(DeleteRegionOperationRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual DeleteRegionOperationResponse Delete(DeleteRegionOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Deletes the specified region-specific Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteRegionOperationRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
DeleteRegionOperationResponse | The response received from the server. |
DeleteAsync(DeleteRegionOperationRequest, CallOptions)
public virtual AsyncUnaryCall<DeleteRegionOperationResponse> DeleteAsync(DeleteRegionOperationRequest request, CallOptions options)Deletes the specified region-specific Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteRegionOperationRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<DeleteRegionOperationResponse> | The call object. |
DeleteAsync(DeleteRegionOperationRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<DeleteRegionOperationResponse> DeleteAsync(DeleteRegionOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Deletes the specified region-specific Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteRegionOperationRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<DeleteRegionOperationResponse> | The call object. |
Get(GetRegionOperationRequest, CallOptions)
public virtual Operation Get(GetRegionOperationRequest request, CallOptions options)Retrieves the specified region-specific Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetRegionOperationRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
Get(GetRegionOperationRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation Get(GetRegionOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Retrieves the specified region-specific Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetRegionOperationRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
GetAsync(GetRegionOperationRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> GetAsync(GetRegionOperationRequest request, CallOptions options)Retrieves the specified region-specific Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetRegionOperationRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |
GetAsync(GetRegionOperationRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> GetAsync(GetRegionOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Retrieves the specified region-specific Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetRegionOperationRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |
List(ListRegionOperationsRequest, CallOptions)
public virtual OperationList List(ListRegionOperationsRequest request, CallOptions options)Retrieves a list of Operation resources contained within the specified region.
| Parameters | |
|---|---|
| Name | Description |
request | ListRegionOperationsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
OperationList | The response received from the server. |
List(ListRegionOperationsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual OperationList List(ListRegionOperationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Retrieves a list of Operation resources contained within the specified region.
| Parameters | |
|---|---|
| Name | Description |
request | ListRegionOperationsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
OperationList | The response received from the server. |
ListAsync(ListRegionOperationsRequest, CallOptions)
public virtual AsyncUnaryCall<OperationList> ListAsync(ListRegionOperationsRequest request, CallOptions options)Retrieves a list of Operation resources contained within the specified region.
| Parameters | |
|---|---|
| Name | Description |
request | ListRegionOperationsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<OperationList> | The call object. |
ListAsync(ListRegionOperationsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<OperationList> ListAsync(ListRegionOperationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Retrieves a list of Operation resources contained within the specified region.
| Parameters | |
|---|---|
| Name | Description |
request | ListRegionOperationsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<OperationList> | The call object. |
NewInstance(ClientBase.ClientBaseConfiguration)
protected override RegionOperations.RegionOperationsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBase.ClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
RegionOperations.RegionOperationsClient | |
Wait(WaitRegionOperationRequest, CallOptions)
public virtual Operation Wait(WaitRegionOperationRequest request, CallOptions options)Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.
| Parameters | |
|---|---|
| Name | Description |
request | WaitRegionOperationRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
Wait(WaitRegionOperationRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation Wait(WaitRegionOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.
| Parameters | |
|---|---|
| Name | Description |
request | WaitRegionOperationRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
WaitAsync(WaitRegionOperationRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> WaitAsync(WaitRegionOperationRequest request, CallOptions options)Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.
| Parameters | |
|---|---|
| Name | Description |
request | WaitRegionOperationRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |
WaitAsync(WaitRegionOperationRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> WaitAsync(WaitRegionOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.
| Parameters | |
|---|---|
| Name | Description |
request | WaitRegionOperationRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |