Compute Engine v1 API - Class GlobalOperations.GlobalOperationsClient (2.16.0)

Version latest

• 2.16.0 (latest)
• 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 class GlobalOperations.GlobalOperationsClient : ClientBase<GlobalOperations.GlobalOperationsClient>

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

Client for GlobalOperations

Inheritance

object > ClientBase > ClientBaseGlobalOperationsGlobalOperationsClient > GlobalOperations.GlobalOperationsClient

Inherited Members

ClientBase<GlobalOperations.GlobalOperationsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

GlobalOperationsClient()

protected GlobalOperationsClient()

Protected parameterless constructor to allow creation of test doubles.

GlobalOperationsClient(CallInvoker)

public GlobalOperationsClient(CallInvoker callInvoker)

Creates a new client for GlobalOperations that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

GlobalOperationsClient(ChannelBase)

public GlobalOperationsClient(ChannelBase channel)

Creates a new client for GlobalOperations

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

GlobalOperationsClient(ClientBaseConfiguration)

protected GlobalOperationsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListGlobalOperationsRequest, CallOptions)

public virtual OperationAggregatedList AggregatedList(AggregatedListGlobalOperationsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
OperationAggregatedList	The response received from the server.

AggregatedList(AggregatedListGlobalOperationsRequest, Metadata, DateTime?, CancellationToken)

public virtual OperationAggregatedList AggregatedList(AggregatedListGlobalOperationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
OperationAggregatedList	The response received from the server.

AggregatedListAsync(AggregatedListGlobalOperationsRequest, CallOptions)

public virtual AsyncUnaryCall<OperationAggregatedList> AggregatedListAsync(AggregatedListGlobalOperationsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperationAggregatedList	The call object.

AggregatedListAsync(AggregatedListGlobalOperationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<OperationAggregatedList> AggregatedListAsync(AggregatedListGlobalOperationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperationAggregatedList	The call object.

Delete(DeleteGlobalOperationRequest, CallOptions)

public virtual DeleteGlobalOperationResponse Delete(DeleteGlobalOperationRequest request, CallOptions options)

Deletes the specified Operations resource.

Parameters
Name	Description
request	DeleteGlobalOperationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
DeleteGlobalOperationResponse	The response received from the server.

Delete(DeleteGlobalOperationRequest, Metadata, DateTime?, CancellationToken)

public virtual DeleteGlobalOperationResponse Delete(DeleteGlobalOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified Operations resource.

Parameters
Name	Description
request	DeleteGlobalOperationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
DeleteGlobalOperationResponse	The response received from the server.

DeleteAsync(DeleteGlobalOperationRequest, CallOptions)

public virtual AsyncUnaryCall<DeleteGlobalOperationResponse> DeleteAsync(DeleteGlobalOperationRequest request, CallOptions options)

Deletes the specified Operations resource.

Parameters
Name	Description
request	DeleteGlobalOperationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallDeleteGlobalOperationResponse	The call object.

DeleteAsync(DeleteGlobalOperationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DeleteGlobalOperationResponse> DeleteAsync(DeleteGlobalOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified Operations resource.

Parameters
Name	Description
request	DeleteGlobalOperationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallDeleteGlobalOperationResponse	The call object.

Get(GetGlobalOperationRequest, CallOptions)

public virtual Operation Get(GetGlobalOperationRequest request, CallOptions options)

Retrieves the specified Operations resource.

Parameters
Name	Description
request	GetGlobalOperationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Get(GetGlobalOperationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Get(GetGlobalOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified Operations resource.

Parameters
Name	Description
request	GetGlobalOperationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

GetAsync(GetGlobalOperationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> GetAsync(GetGlobalOperationRequest request, CallOptions options)

Retrieves the specified Operations resource.

Parameters
Name	Description
request	GetGlobalOperationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

GetAsync(GetGlobalOperationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> GetAsync(GetGlobalOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified Operations resource.

Parameters
Name	Description
request	GetGlobalOperationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

List(ListGlobalOperationsRequest, CallOptions)

public virtual OperationList List(ListGlobalOperationsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListGlobalOperationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
OperationList	The response received from the server.

List(ListGlobalOperationsRequest, Metadata, DateTime?, CancellationToken)

public virtual OperationList List(ListGlobalOperationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListGlobalOperationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
OperationList	The response received from the server.

ListAsync(ListGlobalOperationsRequest, CallOptions)

public virtual AsyncUnaryCall<OperationList> ListAsync(ListGlobalOperationsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListGlobalOperationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperationList	The call object.

ListAsync(ListGlobalOperationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<OperationList> ListAsync(ListGlobalOperationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListGlobalOperationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperationList	The call object.

NewInstance(ClientBaseConfiguration)

protected override GlobalOperations.GlobalOperationsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
GlobalOperationsGlobalOperationsClient

Overrides

ClientBase<GlobalOperations.GlobalOperationsClient>.NewInstance(ClientBase.ClientBaseConfiguration)

Wait(WaitGlobalOperationRequest, CallOptions)

public virtual Operation Wait(WaitGlobalOperationRequest 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	WaitGlobalOperationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Wait(WaitGlobalOperationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Wait(WaitGlobalOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

WaitAsync(WaitGlobalOperationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> WaitAsync(WaitGlobalOperationRequest 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	WaitGlobalOperationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

WaitAsync(WaitGlobalOperationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> WaitAsync(WaitGlobalOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.