Compute Engine v1 API - Class FutureReservations.FutureReservationsClient (3.22.0)

Version latest

• 3.22.0 (latest)
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 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 class FutureReservations.FutureReservationsClient : ClientBase<FutureReservations.FutureReservationsClient>

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

Client for FutureReservations

Inheritance

object > ClientBase > ClientBaseFutureReservationsFutureReservationsClient > FutureReservations.FutureReservationsClient

Inherited Members

ClientBase<FutureReservations.FutureReservationsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

FutureReservationsClient()

protected FutureReservationsClient()

Protected parameterless constructor to allow creation of test doubles.

FutureReservationsClient(CallInvoker)

public FutureReservationsClient(CallInvoker callInvoker)

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

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

FutureReservationsClient(ChannelBase)

public FutureReservationsClient(ChannelBase channel)

Creates a new client for FutureReservations

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

FutureReservationsClient(ClientBaseConfiguration)

protected FutureReservationsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListFutureReservationsRequest, CallOptions)

public virtual FutureReservationsAggregatedListResponse AggregatedList(AggregatedListFutureReservationsRequest request, CallOptions options)

Retrieves an aggregated list of future reservations.

To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.

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

Returns
Type	Description
FutureReservationsAggregatedListResponse	The response received from the server.

AggregatedList(AggregatedListFutureReservationsRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves an aggregated list of future reservations.

To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListFutureReservationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
FutureReservationsAggregatedListResponse	The response received from the server.

AggregatedListAsync(AggregatedListFutureReservationsRequest, CallOptions)

public virtual AsyncUnaryCall<FutureReservationsAggregatedListResponse> AggregatedListAsync(AggregatedListFutureReservationsRequest request, CallOptions options)

Retrieves an aggregated list of future reservations.

To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.

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

Returns
Type	Description
AsyncUnaryCallFutureReservationsAggregatedListResponse	The call object.

AggregatedListAsync(AggregatedListFutureReservationsRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves an aggregated list of future reservations.

To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListFutureReservationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallFutureReservationsAggregatedListResponse	The call object.

Cancel(CancelFutureReservationRequest, CallOptions)

public virtual Operation Cancel(CancelFutureReservationRequest request, CallOptions options)

Cancel the specified future reservation.

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

Returns
Type	Description
Operation	The response received from the server.

Cancel(CancelFutureReservationRequest, Metadata, DateTime?, CancellationToken)

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

Cancel the specified future reservation.

Parameters
Name	Description
request	CancelFutureReservationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.

CancelAsync(CancelFutureReservationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CancelAsync(CancelFutureReservationRequest request, CallOptions options)

Cancel the specified future reservation.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CancelAsync(CancelFutureReservationRequest, Metadata, DateTime?, CancellationToken)

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

Cancel the specified future reservation.

Parameters
Name	Description
request	CancelFutureReservationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.

CreateOperationsClientForZoneOperations()

public virtual Operations.OperationsClient CreateOperationsClientForZoneOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to ZoneOperations.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

Delete(DeleteFutureReservationRequest, CallOptions)

public virtual Operation Delete(DeleteFutureReservationRequest request, CallOptions options)

Deletes the specified future reservation.

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

Returns
Type	Description
Operation	The response received from the server.

Delete(DeleteFutureReservationRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified future reservation.

Parameters
Name	Description
request	DeleteFutureReservationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.

DeleteAsync(DeleteFutureReservationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteFutureReservationRequest request, CallOptions options)

Deletes the specified future reservation.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteFutureReservationRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified future reservation.

Parameters
Name	Description
request	DeleteFutureReservationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.

Get(GetFutureReservationRequest, CallOptions)

public virtual FutureReservation Get(GetFutureReservationRequest request, CallOptions options)

Retrieves information about the specified future reservation.

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

Returns
Type	Description
FutureReservation	The response received from the server.

Get(GetFutureReservationRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves information about the specified future reservation.

Parameters
Name	Description
request	GetFutureReservationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
FutureReservation	The response received from the server.

GetAsync(GetFutureReservationRequest, CallOptions)

public virtual AsyncUnaryCall<FutureReservation> GetAsync(GetFutureReservationRequest request, CallOptions options)

Retrieves information about the specified future reservation.

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

Returns
Type	Description
AsyncUnaryCallFutureReservation	The call object.

GetAsync(GetFutureReservationRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves information about the specified future reservation.

Parameters
Name	Description
request	GetFutureReservationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallFutureReservation	The call object.

Insert(InsertFutureReservationRequest, CallOptions)

public virtual Operation Insert(InsertFutureReservationRequest request, CallOptions options)

Creates a new Future Reservation.

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

Returns
Type	Description
Operation	The response received from the server.

Insert(InsertFutureReservationRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Future Reservation.

Parameters
Name	Description
request	InsertFutureReservationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.

InsertAsync(InsertFutureReservationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertFutureReservationRequest request, CallOptions options)

Creates a new Future Reservation.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertFutureReservationRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Future Reservation.

Parameters
Name	Description
request	InsertFutureReservationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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(ListFutureReservationsRequest, CallOptions)

public virtual FutureReservationsListResponse List(ListFutureReservationsRequest request, CallOptions options)

A list of all the future reservations that have been configured for the specified project in specified zone.

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

Returns
Type	Description
FutureReservationsListResponse	The response received from the server.

List(ListFutureReservationsRequest, Metadata, DateTime?, CancellationToken)

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

A list of all the future reservations that have been configured for the specified project in specified zone.

Parameters
Name	Description
request	ListFutureReservationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
FutureReservationsListResponse	The response received from the server.

ListAsync(ListFutureReservationsRequest, CallOptions)

public virtual AsyncUnaryCall<FutureReservationsListResponse> ListAsync(ListFutureReservationsRequest request, CallOptions options)

A list of all the future reservations that have been configured for the specified project in specified zone.

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

Returns
Type	Description
AsyncUnaryCallFutureReservationsListResponse	The call object.

ListAsync(ListFutureReservationsRequest, Metadata, DateTime?, CancellationToken)

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

A list of all the future reservations that have been configured for the specified project in specified zone.

Parameters
Name	Description
request	ListFutureReservationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallFutureReservationsListResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override FutureReservations.FutureReservationsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
FutureReservationsFutureReservationsClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.FutureReservations.FutureReservationsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Update(UpdateFutureReservationRequest, CallOptions)

public virtual Operation Update(UpdateFutureReservationRequest request, CallOptions options)

Updates the specified future reservation.

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

Returns
Type	Description
Operation	The response received from the server.

Update(UpdateFutureReservationRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified future reservation.

Parameters
Name	Description
request	UpdateFutureReservationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.

UpdateAsync(UpdateFutureReservationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateFutureReservationRequest request, CallOptions options)

Updates the specified future reservation.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateAsync(UpdateFutureReservationRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified future reservation.

Parameters
Name	Description
request	UpdateFutureReservationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.