public sealed class GlobalOperationsClientImpl : GlobalOperationsClientReference documentation and code samples for the Compute Engine v1 API class GlobalOperationsClientImpl.
GlobalOperations client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Compute.V1Assembly
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 | GlobalOperationsGlobalOperationsClientThe underlying gRPC client. |
settings | GlobalOperationsSettingsThe base GlobalOperationsSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override GlobalOperations.GlobalOperationsClient GrpcClient { get; }The underlying gRPC GlobalOperations client
| Property Value | |
|---|---|
| Type | Description |
GlobalOperationsGlobalOperationsClient | |
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 | |
|---|---|
| Name | Description |
request | AggregatedListGlobalOperationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableOperationAggregatedListKeyValuePairstringOperationsScopedList | A pageable sequence of KeyValuePair<TKey, TValue> resources. |
AggregatedListAsync(AggregatedListGlobalOperationsRequest, CallSettings)
public override PagedAsyncEnumerable<OperationAggregatedList, KeyValuePair<string, OperationsScopedList>> AggregatedListAsync(AggregatedListGlobalOperationsRequest request, CallSettings callSettings = null)Retrieves an aggregated list of all operations.
| Parameters | |
|---|---|
| Name | Description |
request | AggregatedListGlobalOperationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableOperationAggregatedListKeyValuePairstringOperationsScopedList | A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources. |
Delete(DeleteGlobalOperationRequest, CallSettings)
public override DeleteGlobalOperationResponse Delete(DeleteGlobalOperationRequest request, CallSettings callSettings = null)Deletes the specified Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteGlobalOperationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
DeleteGlobalOperationResponse | The RPC response. |
DeleteAsync(DeleteGlobalOperationRequest, CallSettings)
public override Task<DeleteGlobalOperationResponse> DeleteAsync(DeleteGlobalOperationRequest request, CallSettings callSettings = null)Deletes the specified Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteGlobalOperationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskDeleteGlobalOperationResponse | A Task containing the RPC response. |
Get(GetGlobalOperationRequest, CallSettings)
public override Operation Get(GetGlobalOperationRequest request, CallSettings callSettings = null)Retrieves the specified Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetGlobalOperationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The RPC response. |
GetAsync(GetGlobalOperationRequest, CallSettings)
public override Task<Operation> GetAsync(GetGlobalOperationRequest request, CallSettings callSettings = null)Retrieves the specified Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetGlobalOperationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperation | A Task containing the RPC response. |
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 | ListGlobalOperationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableOperationListOperation | A pageable sequence of Operation resources. |
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 | ListGlobalOperationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableOperationListOperation | A pageable asynchronous sequence of Operation resources. |
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 | WaitGlobalOperationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The RPC response. |
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 | WaitGlobalOperationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperation | A Task containing the RPC response. |