Compute Engine v1 API - Class GlobalOperationsClientImpl (2.11.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

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
NameDescription
grpcClientGlobalOperationsGlobalOperationsClient

The underlying gRPC client.

settingsGlobalOperationsSettings

The base GlobalOperationsSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override GlobalOperations.GlobalOperationsClient GrpcClient { get; }

The underlying gRPC GlobalOperations client

Property Value
TypeDescription
GlobalOperationsGlobalOperationsClient
Overrides

Methods

AggregatedList(AggregatedListGlobalOperationsRequest, CallSettings)

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

Retrieves an aggregated list of all operations.

Parameters
NameDescription
requestAggregatedListGlobalOperationsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableOperationAggregatedListKeyValuePairstringOperationsScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.

Overrides

AggregatedListAsync(AggregatedListGlobalOperationsRequest, CallSettings)

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

Retrieves an aggregated list of all operations.

Parameters
NameDescription
requestAggregatedListGlobalOperationsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableOperationAggregatedListKeyValuePairstringOperationsScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Overrides

Delete(DeleteGlobalOperationRequest, CallSettings)

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

Deletes the specified Operations resource.

Parameters
NameDescription
requestDeleteGlobalOperationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
DeleteGlobalOperationResponse

The RPC response.

Overrides

DeleteAsync(DeleteGlobalOperationRequest, CallSettings)

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

Deletes the specified Operations resource.

Parameters
NameDescription
requestDeleteGlobalOperationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskDeleteGlobalOperationResponse

A Task containing the RPC response.

Overrides

Get(GetGlobalOperationRequest, CallSettings)

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

Retrieves the specified Operations resource.

Parameters
NameDescription
requestGetGlobalOperationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation

The RPC response.

Overrides

GetAsync(GetGlobalOperationRequest, CallSettings)

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

Retrieves the specified Operations resource.

Parameters
NameDescription
requestGetGlobalOperationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperation

A Task containing the RPC response.

Overrides

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
NameDescription
requestListGlobalOperationsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableOperationListOperation

A pageable sequence of Operation resources.

Overrides

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
NameDescription
requestListGlobalOperationsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableOperationListOperation

A pageable asynchronous sequence of Operation resources.

Overrides

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
NameDescription
requestWaitGlobalOperationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation

The RPC response.

Overrides

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
NameDescription
requestWaitGlobalOperationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperation

A Task containing the RPC response.

Overrides