Compute Engine v1 API - Class ZoneOperations.ZoneOperationsClient (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 ZoneOperations.ZoneOperationsClient : ClientBase<ZoneOperations.ZoneOperationsClient>

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

Client for ZoneOperations

Inheritance

object > ClientBase > ClientBaseZoneOperationsZoneOperationsClient > ZoneOperations.ZoneOperationsClient

Inherited Members

ClientBase<ZoneOperations.ZoneOperationsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

ZoneOperationsClient()

protected ZoneOperationsClient()

Protected parameterless constructor to allow creation of test doubles.

ZoneOperationsClient(CallInvoker)

public ZoneOperationsClient(CallInvoker callInvoker)

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

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

ZoneOperationsClient(ChannelBase)

public ZoneOperationsClient(ChannelBase channel)

Creates a new client for ZoneOperations

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

ZoneOperationsClient(ClientBaseConfiguration)

protected ZoneOperationsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

Delete(DeleteZoneOperationRequest, CallOptions)

public virtual DeleteZoneOperationResponse Delete(DeleteZoneOperationRequest request, CallOptions options)

Deletes the specified zone-specific Operations resource.

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

Returns
Type	Description
DeleteZoneOperationResponse	The response received from the server.

Delete(DeleteZoneOperationRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified zone-specific Operations resource.

Parameters
Name	Description
request	DeleteZoneOperationRequest 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
DeleteZoneOperationResponse	The response received from the server.

DeleteAsync(DeleteZoneOperationRequest, CallOptions)

public virtual AsyncUnaryCall<DeleteZoneOperationResponse> DeleteAsync(DeleteZoneOperationRequest request, CallOptions options)

Deletes the specified zone-specific Operations resource.

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

Returns
Type	Description
AsyncUnaryCallDeleteZoneOperationResponse	The call object.

DeleteAsync(DeleteZoneOperationRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified zone-specific Operations resource.

Parameters
Name	Description
request	DeleteZoneOperationRequest 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
AsyncUnaryCallDeleteZoneOperationResponse	The call object.

Get(GetZoneOperationRequest, CallOptions)

public virtual Operation Get(GetZoneOperationRequest request, CallOptions options)

Retrieves the specified zone-specific Operations resource.

Parameters
Name	Description
request	GetZoneOperationRequest 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(GetZoneOperationRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the specified zone-specific Operations resource.

Parameters
Name	Description
request	GetZoneOperationRequest 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(GetZoneOperationRequest, CallOptions)

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

Retrieves the specified zone-specific Operations resource.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

GetAsync(GetZoneOperationRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the specified zone-specific Operations resource.

Parameters
Name	Description
request	GetZoneOperationRequest 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(ListZoneOperationsRequest, CallOptions)

public virtual OperationList List(ListZoneOperationsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListZoneOperationsRequest 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(ListZoneOperationsRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	ListZoneOperationsRequest 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(ListZoneOperationsRequest, CallOptions)

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

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

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

Returns
Type	Description
AsyncUnaryCallOperationList	The call object.

ListAsync(ListZoneOperationsRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	ListZoneOperationsRequest 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 ZoneOperations.ZoneOperationsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
ZoneOperationsZoneOperationsClient

Overrides

ClientBase<ZoneOperations.ZoneOperationsClient>.NewInstance(ClientBase.ClientBaseConfiguration)

Wait(WaitZoneOperationRequest, CallOptions)

public virtual Operation Wait(WaitZoneOperationRequest 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 waits for no more than the 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	WaitZoneOperationRequest 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(WaitZoneOperationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Wait(WaitZoneOperationRequest 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 waits for no more than the 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	WaitZoneOperationRequest 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(WaitZoneOperationRequest, CallOptions)

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

WaitAsync(WaitZoneOperationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> WaitAsync(WaitZoneOperationRequest 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 waits for no more than the 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	WaitZoneOperationRequest 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.