Compute Engine v1 API - Class GlobalOperationsClientImpl (3.1.0)

Version latest

• 3.1.0 (latest)
• 3.0.0
• 2.17.0
• 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 GlobalOperationsClientImpl : GlobalOperationsClient

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

GlobalOperations client wrapper implementation, for convenient use.

Inheritance

object > GlobalOperationsClient > GlobalOperationsClientImpl

Inherited Members

GlobalOperationsClient.DefaultEndpoint

GlobalOperationsClient.DefaultScopes

GlobalOperationsClient.ServiceMetadata

GlobalOperationsClient.CreateAsync(CancellationToken)

GlobalOperationsClient.Create()

GlobalOperationsClient.ShutdownDefaultChannelsAsync()

GlobalOperationsClient.AggregatedList(string, string, int?, CallSettings)

GlobalOperationsClient.AggregatedListAsync(string, string, int?, CallSettings)

GlobalOperationsClient.DeleteAsync(DeleteGlobalOperationRequest, CancellationToken)

GlobalOperationsClient.Delete(string, string, CallSettings)

GlobalOperationsClient.DeleteAsync(string, string, CallSettings)

GlobalOperationsClient.DeleteAsync(string, string, CancellationToken)

GlobalOperationsClient.GetAsync(GetGlobalOperationRequest, CancellationToken)

GlobalOperationsClient.Get(string, string, CallSettings)

GlobalOperationsClient.GetAsync(string, string, CallSettings)

GlobalOperationsClient.GetAsync(string, string, CancellationToken)

GlobalOperationsClient.List(string, string, int?, CallSettings)

GlobalOperationsClient.ListAsync(string, string, int?, CallSettings)

GlobalOperationsClient.WaitAsync(WaitGlobalOperationRequest, CancellationToken)

GlobalOperationsClient.Wait(string, string, CallSettings)

GlobalOperationsClient.WaitAsync(string, string, CallSettings)

GlobalOperationsClient.WaitAsync(string, string, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The GlobalOperations API.

Constructors

GlobalOperationsClientImpl(GlobalOperationsClient, GlobalOperationsSettings, ILogger)

public GlobalOperationsClientImpl(GlobalOperations.GlobalOperationsClient grpcClient, GlobalOperationsSettings settings, ILogger logger)

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

Parameters
Name	Description
grpcClient	GlobalOperationsGlobalOperationsClient The underlying gRPC client.
settings	GlobalOperationsSettings The base GlobalOperationsSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override GlobalOperations.GlobalOperationsClient GrpcClient { get; }

The underlying gRPC GlobalOperations client

Property Value
Type	Description
GlobalOperationsGlobalOperationsClient

Overrides

GlobalOperationsClient.GrpcClient

Methods

AggregatedList(AggregatedListGlobalOperationsRequest, CallSettings)

public override PagedEnumerable<OperationAggregatedList, KeyValuePair<string, OperationsScopedList>> AggregatedList(AggregatedListGlobalOperationsRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListGlobalOperationsRequest 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
PagedEnumerableOperationAggregatedListKeyValuePairstringOperationsScopedList	A pageable sequence of KeyValuePair<TKey, TValue> resources.

Overrides

GlobalOperationsClient.AggregatedList(AggregatedListGlobalOperationsRequest, CallSettings)

AggregatedListAsync(AggregatedListGlobalOperationsRequest, CallSettings)

public override PagedAsyncEnumerable<OperationAggregatedList, KeyValuePair<string, OperationsScopedList>> AggregatedListAsync(AggregatedListGlobalOperationsRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListGlobalOperationsRequest 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
PagedAsyncEnumerableOperationAggregatedListKeyValuePairstringOperationsScopedList	A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Overrides

GlobalOperationsClient.AggregatedListAsync(AggregatedListGlobalOperationsRequest, CallSettings)

Delete(DeleteGlobalOperationRequest, CallSettings)

public override DeleteGlobalOperationResponse Delete(DeleteGlobalOperationRequest request, CallSettings callSettings = null)

Deletes the specified Operations resource.

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

Overrides

GlobalOperationsClient.Delete(DeleteGlobalOperationRequest, CallSettings)

DeleteAsync(DeleteGlobalOperationRequest, CallSettings)

public override Task<DeleteGlobalOperationResponse> DeleteAsync(DeleteGlobalOperationRequest request, CallSettings callSettings = null)

Deletes the specified Operations resource.

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

Overrides

GlobalOperationsClient.DeleteAsync(DeleteGlobalOperationRequest, CallSettings)

Get(GetGlobalOperationRequest, CallSettings)

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

Retrieves the specified Operations resource.

Parameters
Name	Description
request	GetGlobalOperationRequest 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

GlobalOperationsClient.Get(GetGlobalOperationRequest, CallSettings)

GetAsync(GetGlobalOperationRequest, CallSettings)

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

Retrieves the specified Operations resource.

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

Overrides

GlobalOperationsClient.GetAsync(GetGlobalOperationRequest, CallSettings)

List(ListGlobalOperationsRequest, CallSettings)

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

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

Parameters
Name	Description
request	ListGlobalOperationsRequest 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
PagedEnumerableOperationListOperation	A pageable sequence of Operation resources.

Overrides

GlobalOperationsClient.List(ListGlobalOperationsRequest, CallSettings)

ListAsync(ListGlobalOperationsRequest, CallSettings)

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

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

Parameters
Name	Description
request	ListGlobalOperationsRequest 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
PagedAsyncEnumerableOperationListOperation	A pageable asynchronous sequence of Operation resources.

Overrides

GlobalOperationsClient.ListAsync(ListGlobalOperationsRequest, CallSettings)

Wait(WaitGlobalOperationRequest, CallSettings)

public override Operation Wait(WaitGlobalOperationRequest 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	WaitGlobalOperationRequest 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

GlobalOperationsClient.Wait(WaitGlobalOperationRequest, CallSettings)

WaitAsync(WaitGlobalOperationRequest, CallSettings)

public override Task<Operation> WaitAsync(WaitGlobalOperationRequest 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	WaitGlobalOperationRequest 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
TaskOperation	A Task containing the RPC response.

Overrides

GlobalOperationsClient.WaitAsync(WaitGlobalOperationRequest, CallSettings)