Compute Engine v1 API - Class RegionOperationsClientImpl (2.5.0)

Version 2.5.0

• 2.17.0 (latest)
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class RegionOperationsClientImpl : RegionOperationsClient

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

RegionOperations client wrapper implementation, for convenient use.

Inheritance

Object > RegionOperationsClient > RegionOperationsClientImpl

Inherited Members

RegionOperationsClient.DefaultEndpoint

RegionOperationsClient.DefaultScopes

RegionOperationsClient.ServiceMetadata

RegionOperationsClient.CreateAsync(CancellationToken)

RegionOperationsClient.Create()

RegionOperationsClient.ShutdownDefaultChannelsAsync()

RegionOperationsClient.DeleteAsync(DeleteRegionOperationRequest, CancellationToken)

RegionOperationsClient.Delete(String, String, String, CallSettings)

RegionOperationsClient.DeleteAsync(String, String, String, CallSettings)

RegionOperationsClient.DeleteAsync(String, String, String, CancellationToken)

RegionOperationsClient.GetAsync(GetRegionOperationRequest, CancellationToken)

RegionOperationsClient.Get(String, String, String, CallSettings)

RegionOperationsClient.GetAsync(String, String, String, CallSettings)

RegionOperationsClient.GetAsync(String, String, String, CancellationToken)

RegionOperationsClient.List(String, String, String, Nullable<Int32>, CallSettings)

RegionOperationsClient.ListAsync(String, String, String, Nullable<Int32>, CallSettings)

RegionOperationsClient.WaitAsync(WaitRegionOperationRequest, CancellationToken)

RegionOperationsClient.Wait(String, String, String, CallSettings)

RegionOperationsClient.WaitAsync(String, String, String, CallSettings)

RegionOperationsClient.WaitAsync(String, String, String, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The RegionOperations API.

Constructors

RegionOperationsClientImpl(RegionOperations.RegionOperationsClient, RegionOperationsSettings, ILogger)

public RegionOperationsClientImpl(RegionOperations.RegionOperationsClient grpcClient, RegionOperationsSettings settings, ILogger logger)

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

Parameters
Name	Description
grpcClient	RegionOperations.RegionOperationsClient The underlying gRPC client.
settings	RegionOperationsSettings The base RegionOperationsSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override RegionOperations.RegionOperationsClient GrpcClient { get; }

The underlying gRPC RegionOperations client

Property Value
Type	Description
RegionOperations.RegionOperationsClient

Overrides

RegionOperationsClient.GrpcClient

Methods

Delete(DeleteRegionOperationRequest, CallSettings)

public override DeleteRegionOperationResponse Delete(DeleteRegionOperationRequest request, CallSettings callSettings = null)

Deletes the specified region-specific Operations resource.

Parameters
Name	Description
request	DeleteRegionOperationRequest 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
DeleteRegionOperationResponse	The RPC response.

Overrides

RegionOperationsClient.Delete(DeleteRegionOperationRequest, CallSettings)

DeleteAsync(DeleteRegionOperationRequest, CallSettings)

public override Task<DeleteRegionOperationResponse> DeleteAsync(DeleteRegionOperationRequest request, CallSettings callSettings = null)

Deletes the specified region-specific Operations resource.

Parameters
Name	Description
request	DeleteRegionOperationRequest 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
Task<DeleteRegionOperationResponse>	A Task containing the RPC response.

Overrides

RegionOperationsClient.DeleteAsync(DeleteRegionOperationRequest, CallSettings)

Get(GetRegionOperationRequest, CallSettings)

public override Operation Get(GetRegionOperationRequest request, CallSettings callSettings = null)

Retrieves the specified region-specific Operations resource.

Parameters
Name	Description
request	GetRegionOperationRequest 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
Operation	The RPC response.

Overrides

RegionOperationsClient.Get(GetRegionOperationRequest, CallSettings)

GetAsync(GetRegionOperationRequest, CallSettings)

public override Task<Operation> GetAsync(GetRegionOperationRequest request, CallSettings callSettings = null)

Retrieves the specified region-specific Operations resource.

Parameters
Name	Description
request	GetRegionOperationRequest 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
Task<Operation>	A Task containing the RPC response.

Overrides

RegionOperationsClient.GetAsync(GetRegionOperationRequest, CallSettings)

List(ListRegionOperationsRequest, CallSettings)

public override PagedEnumerable<OperationList, Operation> List(ListRegionOperationsRequest request, CallSettings callSettings = null)

Retrieves a list of Operation resources contained within the specified region.

Parameters
Name	Description
request	ListRegionOperationsRequest 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
PagedEnumerable<OperationList, Operation>	A pageable sequence of Operation resources.

Overrides

RegionOperationsClient.List(ListRegionOperationsRequest, CallSettings)

ListAsync(ListRegionOperationsRequest, CallSettings)

public override PagedAsyncEnumerable<OperationList, Operation> ListAsync(ListRegionOperationsRequest request, CallSettings callSettings = null)

Retrieves a list of Operation resources contained within the specified region.

Parameters
Name	Description
request	ListRegionOperationsRequest 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
PagedAsyncEnumerable<OperationList, Operation>	A pageable asynchronous sequence of Operation resources.

Overrides

RegionOperationsClient.ListAsync(ListRegionOperationsRequest, CallSettings)

Wait(WaitRegionOperationRequest, CallSettings)

public override Operation Wait(WaitRegionOperationRequest request, CallSettings callSettings = null)

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	WaitRegionOperationRequest 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
Operation	The RPC response.

Overrides

RegionOperationsClient.Wait(WaitRegionOperationRequest, CallSettings)

WaitAsync(WaitRegionOperationRequest, CallSettings)

public override Task<Operation> WaitAsync(WaitRegionOperationRequest request, CallSettings callSettings = null)

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	WaitRegionOperationRequest 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
Task<Operation>	A Task containing the RPC response.

Overrides

RegionOperationsClient.WaitAsync(WaitRegionOperationRequest, CallSettings)