Compute Engine v1 API - Class ReservationsClientImpl (2.15.0)

public sealed class ReservationsClientImpl : ReservationsClient

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

Reservations client wrapper implementation, for convenient use.

Inheritance

object > ReservationsClient > ReservationsClientImpl

Inherited Members

ReservationsClient.DefaultEndpoint

ReservationsClient.DefaultScopes

ReservationsClient.ServiceMetadata

ReservationsClient.CreateAsync(CancellationToken)

ReservationsClient.Create()

ReservationsClient.ShutdownDefaultChannelsAsync()

ReservationsClient.AggregatedList(string, string, int?, CallSettings)

ReservationsClient.AggregatedListAsync(string, string, int?, CallSettings)

ReservationsClient.DeleteAsync(DeleteReservationRequest, CancellationToken)

ReservationsClient.PollOnceDelete(string, CallSettings)

ReservationsClient.PollOnceDeleteAsync(string, CallSettings)

ReservationsClient.Delete(string, string, string, CallSettings)

ReservationsClient.DeleteAsync(string, string, string, CallSettings)

ReservationsClient.DeleteAsync(string, string, string, CancellationToken)

ReservationsClient.GetAsync(GetReservationRequest, CancellationToken)

ReservationsClient.Get(string, string, string, CallSettings)

ReservationsClient.GetAsync(string, string, string, CallSettings)

ReservationsClient.GetAsync(string, string, string, CancellationToken)

ReservationsClient.GetIamPolicyAsync(GetIamPolicyReservationRequest, CancellationToken)

ReservationsClient.GetIamPolicy(string, string, string, CallSettings)

ReservationsClient.GetIamPolicyAsync(string, string, string, CallSettings)

ReservationsClient.GetIamPolicyAsync(string, string, string, CancellationToken)

ReservationsClient.InsertAsync(InsertReservationRequest, CancellationToken)

ReservationsClient.PollOnceInsert(string, CallSettings)

ReservationsClient.PollOnceInsertAsync(string, CallSettings)

ReservationsClient.Insert(string, string, Reservation, CallSettings)

ReservationsClient.InsertAsync(string, string, Reservation, CallSettings)

ReservationsClient.InsertAsync(string, string, Reservation, CancellationToken)

ReservationsClient.List(string, string, string, int?, CallSettings)

ReservationsClient.ListAsync(string, string, string, int?, CallSettings)

ReservationsClient.ResizeAsync(ResizeReservationRequest, CancellationToken)

ReservationsClient.PollOnceResize(string, CallSettings)

ReservationsClient.PollOnceResizeAsync(string, CallSettings)

ReservationsClient.Resize(string, string, string, ReservationsResizeRequest, CallSettings)

ReservationsClient.ResizeAsync(string, string, string, ReservationsResizeRequest, CallSettings)

ReservationsClient.ResizeAsync(string, string, string, ReservationsResizeRequest, CancellationToken)

ReservationsClient.SetIamPolicyAsync(SetIamPolicyReservationRequest, CancellationToken)

ReservationsClient.SetIamPolicy(string, string, string, ZoneSetPolicyRequest, CallSettings)

ReservationsClient.SetIamPolicyAsync(string, string, string, ZoneSetPolicyRequest, CallSettings)

ReservationsClient.SetIamPolicyAsync(string, string, string, ZoneSetPolicyRequest, CancellationToken)

ReservationsClient.TestIamPermissionsAsync(TestIamPermissionsReservationRequest, CancellationToken)

ReservationsClient.TestIamPermissions(string, string, string, TestPermissionsRequest, CallSettings)

ReservationsClient.TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CallSettings)

ReservationsClient.TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CancellationToken)

ReservationsClient.UpdateAsync(UpdateReservationRequest, CancellationToken)

ReservationsClient.PollOnceUpdate(string, CallSettings)

ReservationsClient.PollOnceUpdateAsync(string, CallSettings)

ReservationsClient.Update(string, string, string, Reservation, CallSettings)

ReservationsClient.UpdateAsync(string, string, string, Reservation, CallSettings)

ReservationsClient.UpdateAsync(string, string, string, Reservation, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The Reservations API.

Constructors

ReservationsClientImpl(ReservationsClient, ReservationsSettings, ILogger)

public ReservationsClientImpl(Reservations.ReservationsClient grpcClient, ReservationsSettings settings, ILogger logger)

Constructs a client wrapper for the Reservations service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`ReservationsReservationsClient` The underlying gRPC client.
`settings`	`ReservationsSettings` The base ReservationsSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
`OperationsClient`

Overrides

ReservationsClient.DeleteOperationsClient

GrpcClient

public override Reservations.ReservationsClient GrpcClient { get; }

The underlying gRPC Reservations client

Property Value
Type	Description
`ReservationsReservationsClient`

Overrides

ReservationsClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
`OperationsClient`

Overrides

ReservationsClient.InsertOperationsClient

ResizeOperationsClient

public override OperationsClient ResizeOperationsClient { get; }

The long-running operations client for Resize.

Property Value
Type	Description
`OperationsClient`

Overrides

ReservationsClient.ResizeOperationsClient

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
Type	Description
`OperationsClient`

Overrides

ReservationsClient.UpdateOperationsClient

Methods

AggregatedList(AggregatedListReservationsRequest, CallSettings)

public override PagedEnumerable<ReservationAggregatedList, KeyValuePair<string, ReservationsScopedList>> AggregatedList(AggregatedListReservationsRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of reservations. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
`request`	`AggregatedListReservationsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableReservationAggregatedListKeyValuePairstringReservationsScopedList`	A pageable sequence of KeyValuePair<TKey, TValue> resources.

Overrides

ReservationsClient.AggregatedList(AggregatedListReservationsRequest, CallSettings)

AggregatedListAsync(AggregatedListReservationsRequest, CallSettings)

public override PagedAsyncEnumerable<ReservationAggregatedList, KeyValuePair<string, ReservationsScopedList>> AggregatedListAsync(AggregatedListReservationsRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of reservations. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
`request`	`AggregatedListReservationsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableReservationAggregatedListKeyValuePairstringReservationsScopedList`	A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Overrides

ReservationsClient.AggregatedListAsync(AggregatedListReservationsRequest, CallSettings)

Delete(DeleteReservationRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteReservationRequest request, CallSettings callSettings = null)

Deletes the specified reservation.

Parameters
Name	Description
`request`	`DeleteReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

ReservationsClient.Delete(DeleteReservationRequest, CallSettings)

DeleteAsync(DeleteReservationRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteReservationRequest request, CallSettings callSettings = null)

Deletes the specified reservation.

Parameters
Name	Description
`request`	`DeleteReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

ReservationsClient.DeleteAsync(DeleteReservationRequest, CallSettings)

Get(GetReservationRequest, CallSettings)

public override Reservation Get(GetReservationRequest request, CallSettings callSettings = null)

Retrieves information about the specified reservation.

Parameters
Name	Description
`request`	`GetReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Reservation`	The RPC response.

Overrides

ReservationsClient.Get(GetReservationRequest, CallSettings)

GetAsync(GetReservationRequest, CallSettings)

public override Task<Reservation> GetAsync(GetReservationRequest request, CallSettings callSettings = null)

Retrieves information about the specified reservation.

Parameters
Name	Description
`request`	`GetReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskReservation`	A Task containing the RPC response.

Overrides

ReservationsClient.GetAsync(GetReservationRequest, CallSettings)

GetIamPolicy(GetIamPolicyReservationRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyReservationRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name	Description
`request`	`GetIamPolicyReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Policy`	The RPC response.

Overrides

ReservationsClient.GetIamPolicy(GetIamPolicyReservationRequest, CallSettings)

GetIamPolicyAsync(GetIamPolicyReservationRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyReservationRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name	Description
`request`	`GetIamPolicyReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPolicy`	A Task containing the RPC response.

Overrides

ReservationsClient.GetIamPolicyAsync(GetIamPolicyReservationRequest, CallSettings)

Insert(InsertReservationRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertReservationRequest request, CallSettings callSettings = null)

Creates a new reservation. For more information, read Reserving zonal resources.

Parameters
Name	Description
`request`	`InsertReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

ReservationsClient.Insert(InsertReservationRequest, CallSettings)

InsertAsync(InsertReservationRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InsertAsync(InsertReservationRequest request, CallSettings callSettings = null)

Creates a new reservation. For more information, read Reserving zonal resources.

Parameters
Name	Description
`request`	`InsertReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

ReservationsClient.InsertAsync(InsertReservationRequest, CallSettings)

List(ListReservationsRequest, CallSettings)

public override PagedEnumerable<ReservationList, Reservation> List(ListReservationsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`ListReservationsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableReservationListReservation`	A pageable sequence of Reservation resources.

Overrides

ReservationsClient.List(ListReservationsRequest, CallSettings)

ListAsync(ListReservationsRequest, CallSettings)

public override PagedAsyncEnumerable<ReservationList, Reservation> ListAsync(ListReservationsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`ListReservationsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableReservationListReservation`	A pageable asynchronous sequence of Reservation resources.

Overrides

ReservationsClient.ListAsync(ListReservationsRequest, CallSettings)

Resize(ResizeReservationRequest, CallSettings)

public override Operation<Operation, Operation> Resize(ResizeReservationRequest request, CallSettings callSettings = null)

Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.

Parameters
Name	Description
`request`	`ResizeReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

ReservationsClient.Resize(ResizeReservationRequest, CallSettings)

ResizeAsync(ResizeReservationRequest, CallSettings)

public override Task<Operation<Operation, Operation>> ResizeAsync(ResizeReservationRequest request, CallSettings callSettings = null)

Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.

Parameters
Name	Description
`request`	`ResizeReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

ReservationsClient.ResizeAsync(ResizeReservationRequest, CallSettings)

SetIamPolicy(SetIamPolicyReservationRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyReservationRequest request, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name	Description
`request`	`SetIamPolicyReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Policy`	The RPC response.

Overrides

ReservationsClient.SetIamPolicy(SetIamPolicyReservationRequest, CallSettings)

SetIamPolicyAsync(SetIamPolicyReservationRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyReservationRequest request, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name	Description
`request`	`SetIamPolicyReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPolicy`	A Task containing the RPC response.

Overrides

ReservationsClient.SetIamPolicyAsync(SetIamPolicyReservationRequest, CallSettings)

TestIamPermissions(TestIamPermissionsReservationRequest, CallSettings)

public override TestPermissionsResponse TestIamPermissions(TestIamPermissionsReservationRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
`request`	`TestIamPermissionsReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TestPermissionsResponse`	The RPC response.

Overrides

ReservationsClient.TestIamPermissions(TestIamPermissionsReservationRequest, CallSettings)

TestIamPermissionsAsync(TestIamPermissionsReservationRequest, CallSettings)

public override Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsReservationRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
`request`	`TestIamPermissionsReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskTestPermissionsResponse`	A Task containing the RPC response.

Overrides

ReservationsClient.TestIamPermissionsAsync(TestIamPermissionsReservationRequest, CallSettings)

Update(UpdateReservationRequest, CallSettings)

public override Operation<Operation, Operation> Update(UpdateReservationRequest request, CallSettings callSettings = null)

Update share settings of the reservation.

Parameters
Name	Description
`request`	`UpdateReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

ReservationsClient.Update(UpdateReservationRequest, CallSettings)

UpdateAsync(UpdateReservationRequest, CallSettings)

public override Task<Operation<Operation, Operation>> UpdateAsync(UpdateReservationRequest request, CallSettings callSettings = null)

Update share settings of the reservation.

Parameters
Name	Description
`request`	`UpdateReservationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

ReservationsClient.UpdateAsync(UpdateReservationRequest, CallSettings)