Class ReservationsClient (1.62.0)

GitHub RepositoryProduct Reference

Service Description: The Reservations API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String reservation = "reservation-1563081780";
   Reservation response = reservationsClient.get(project, zone, reservation);
 }

Note: close() needs to be called on the ReservationsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

AggregatedList

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • aggregatedList(AggregatedListReservationsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • aggregatedList(String project)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • aggregatedListPagedCallable()

  • aggregatedListCallable()

Delete

Deletes the specified reservation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAsync(DeleteReservationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteAsync(String project, String zone, String reservation)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteOperationCallable()

  • deleteCallable()

Get

Retrieves information about the specified reservation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • get(GetReservationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • get(String project, String zone, String reservation)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCallable()

GetIamPolicy

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIamPolicy(GetIamPolicyReservationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getIamPolicy(String project, String zone, String resource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

Insert

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • insertAsync(InsertReservationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • insertAsync(String project, String zone, Reservation reservationResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • insertOperationCallable()

  • insertCallable()

List

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • list(ListReservationsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • list(String project, String zone)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPagedCallable()

  • listCallable()

Resize

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • resizeAsync(ResizeReservationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • resizeAsync(String project, String zone, String reservation, ReservationsResizeRequest reservationsResizeRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • resizeOperationCallable()

  • resizeCallable()

SetIamPolicy

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setIamPolicy(SetIamPolicyReservationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • setIamPolicy(String project, String zone, String resource, ZoneSetPolicyRequest zoneSetPolicyRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testIamPermissions(TestIamPermissionsReservationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • testIamPermissions(String project, String zone, String resource, TestPermissionsRequest testPermissionsRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

Update

Update share settings of the reservation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAsync(UpdateReservationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateAsync(String project, String zone, String reservation, Reservation reservationResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateOperationCallable()

  • updateCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ReservationsSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ReservationsSettings reservationsSettings =
     ReservationsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ReservationsClient reservationsClient = ReservationsClient.create(reservationsSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ReservationsSettings reservationsSettings =
     ReservationsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ReservationsClient reservationsClient = ReservationsClient.create(reservationsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > ReservationsClient

Static Methods

create()

public static final ReservationsClient create()

Constructs an instance of ReservationsClient with default settings.

Returns
Type Description
ReservationsClient
Exceptions
Type Description
IOException

create(ReservationsSettings settings)

public static final ReservationsClient create(ReservationsSettings settings)

Constructs an instance of ReservationsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings ReservationsSettings
Returns
Type Description
ReservationsClient
Exceptions
Type Description
IOException

create(ReservationsStub stub)

public static final ReservationsClient create(ReservationsStub stub)

Constructs an instance of ReservationsClient, using the given stub for making calls. This is for advanced usage - prefer using create(ReservationsSettings).

Parameter
Name Description
stub ReservationsStub
Returns
Type Description
ReservationsClient

Constructors

ReservationsClient(ReservationsSettings settings)

protected ReservationsClient(ReservationsSettings settings)

Constructs an instance of ReservationsClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings ReservationsSettings

ReservationsClient(ReservationsStub stub)

protected ReservationsClient(ReservationsStub stub)
Parameter
Name Description
stub ReservationsStub

Methods

aggregatedList(AggregatedListReservationsRequest request)

public final ReservationsClient.AggregatedListPagedResponse aggregatedList(AggregatedListReservationsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   AggregatedListReservationsRequest request =
       AggregatedListReservationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   for (Map.Entry<String, ReservationsScopedList> element :
       reservationsClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request AggregatedListReservationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ReservationsClient.AggregatedListPagedResponse

aggregatedList(String project)

public final ReservationsClient.AggregatedListPagedResponse aggregatedList(String project)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, ReservationsScopedList> element :
       reservationsClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
ReservationsClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListReservationsRequest,ReservationAggregatedList> aggregatedListCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   AggregatedListReservationsRequest request =
       AggregatedListReservationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     ReservationAggregatedList response =
         reservationsClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, ReservationsScopedList> element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListReservationsRequest,ReservationAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListReservationsRequest,ReservationsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   AggregatedListReservationsRequest request =
       AggregatedListReservationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   ApiFuture<Map.Entry<String, ReservationsScopedList>> future =
       reservationsClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, ReservationsScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListReservationsRequest,AggregatedListPagedResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

deleteAsync(DeleteReservationRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteReservationRequest request)

Deletes the specified reservation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   DeleteReservationRequest request =
       DeleteReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservation("reservation-1563081780")
           .setZone("zone3744684")
           .build();
   Operation response = reservationsClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeleteReservationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String zone, String reservation)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String zone, String reservation)

Deletes the specified reservation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String reservation = "reservation-1563081780";
   Operation response = reservationsClient.deleteAsync(project, zone, reservation).get();
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone for this request.
reservation String

Name of the reservation to delete.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteReservationRequest,Operation> deleteCallable()

Deletes the specified reservation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   DeleteReservationRequest request =
       DeleteReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservation("reservation-1563081780")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = reservationsClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteReservationRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteReservationRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified reservation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   DeleteReservationRequest request =
       DeleteReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservation("reservation-1563081780")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       reservationsClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteReservationRequest,Operation,Operation>

get(GetReservationRequest request)

public final Reservation get(GetReservationRequest request)

Retrieves information about the specified reservation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   GetReservationRequest request =
       GetReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setReservation("reservation-1563081780")
           .setZone("zone3744684")
           .build();
   Reservation response = reservationsClient.get(request);
 }
Parameter
Name Description
request GetReservationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Reservation

get(String project, String zone, String reservation)

public final Reservation get(String project, String zone, String reservation)

Retrieves information about the specified reservation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String reservation = "reservation-1563081780";
   Reservation response = reservationsClient.get(project, zone, reservation);
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone for this request.
reservation String

Name of the reservation to retrieve.
Returns
Type Description
Reservation

getCallable()

public final UnaryCallable<GetReservationRequest,Reservation> getCallable()

Retrieves information about the specified reservation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   GetReservationRequest request =
       GetReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setReservation("reservation-1563081780")
           .setZone("zone3744684")
           .build();
   ApiFuture<Reservation> future = reservationsClient.getCallable().futureCall(request);
   // Do something.
   Reservation response = future.get();
 }
Returns
Type Description
UnaryCallable<GetReservationRequest,Reservation>

getIamPolicy(GetIamPolicyReservationRequest request)

public final Policy getIamPolicy(GetIamPolicyReservationRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   GetIamPolicyReservationRequest request =
       GetIamPolicyReservationRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .build();
   Policy response = reservationsClient.getIamPolicy(request);
 }
Parameter
Name Description
request GetIamPolicyReservationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Policy

getIamPolicy(String project, String zone, String resource)

public final Policy getIamPolicy(String project, String zone, String resource)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String resource = "resource-341064690";
   Policy response = reservationsClient.getIamPolicy(project, zone, resource);
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

The name of the zone for this request.
resource String

Name or id of the resource for this request.
Returns
Type Description
Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyReservationRequest,Policy> getIamPolicyCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   GetIamPolicyReservationRequest request =
       GetIamPolicyReservationRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .build();
   ApiFuture<Policy> future = reservationsClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<GetIamPolicyReservationRequest,Policy>

getSettings()

public final ReservationsSettings getSettings()
Returns
Type Description
ReservationsSettings

getStub()

public ReservationsStub getStub()
Returns
Type Description
ReservationsStub

insertAsync(InsertReservationRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertReservationRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   InsertReservationRequest request =
       InsertReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservationResource(Reservation.newBuilder().build())
           .setZone("zone3744684")
           .build();
   Operation response = reservationsClient.insertAsync(request).get();
 }
Parameter
Name Description
request InsertReservationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

insertAsync(String project, String zone, Reservation reservationResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String zone, Reservation reservationResource)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   Reservation reservationResource = Reservation.newBuilder().build();
   Operation response = reservationsClient.insertAsync(project, zone, reservationResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone for this request.
reservationResource Reservation

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertReservationRequest,Operation> insertCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   InsertReservationRequest request =
       InsertReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservationResource(Reservation.newBuilder().build())
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = reservationsClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<InsertReservationRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertReservationRequest,Operation,Operation> insertOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   InsertReservationRequest request =
       InsertReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservationResource(Reservation.newBuilder().build())
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       reservationsClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<InsertReservationRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListReservationsRequest request)

public final ReservationsClient.ListPagedResponse list(ListReservationsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   ListReservationsRequest request =
       ListReservationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (Reservation element : reservationsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListReservationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ReservationsClient.ListPagedResponse

list(String project, String zone)

public final ReservationsClient.ListPagedResponse list(String project, String zone)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   for (Reservation element : reservationsClient.list(project, zone).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone for this request.
Returns
Type Description
ReservationsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListReservationsRequest,ReservationList> listCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   ListReservationsRequest request =
       ListReservationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     ReservationList response = reservationsClient.listCallable().call(request);
     for (Reservation element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListReservationsRequest,ReservationList>

listPagedCallable()

public final UnaryCallable<ListReservationsRequest,ReservationsClient.ListPagedResponse> listPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   ListReservationsRequest request =
       ListReservationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture<Reservation> future = reservationsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (Reservation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListReservationsRequest,ListPagedResponse>

resizeAsync(ResizeReservationRequest request)

public final OperationFuture<Operation,Operation> resizeAsync(ResizeReservationRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   ResizeReservationRequest request =
       ResizeReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservation("reservation-1563081780")
           .setReservationsResizeRequestResource(ReservationsResizeRequest.newBuilder().build())
           .setZone("zone3744684")
           .build();
   Operation response = reservationsClient.resizeAsync(request).get();
 }
Parameter
Name Description
request ResizeReservationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

resizeAsync(String project, String zone, String reservation, ReservationsResizeRequest reservationsResizeRequestResource)

public final OperationFuture<Operation,Operation> resizeAsync(String project, String zone, String reservation, ReservationsResizeRequest reservationsResizeRequestResource)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String reservation = "reservation-1563081780";
   ReservationsResizeRequest reservationsResizeRequestResource =
       ReservationsResizeRequest.newBuilder().build();
   Operation response =
       reservationsClient
           .resizeAsync(project, zone, reservation, reservationsResizeRequestResource)
           .get();
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone for this request.
reservation String

Name of the reservation to update.
reservationsResizeRequestResource ReservationsResizeRequest

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

resizeCallable()

public final UnaryCallable<ResizeReservationRequest,Operation> resizeCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   ResizeReservationRequest request =
       ResizeReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservation("reservation-1563081780")
           .setReservationsResizeRequestResource(ReservationsResizeRequest.newBuilder().build())
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = reservationsClient.resizeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<ResizeReservationRequest,Operation>

resizeOperationCallable()

public final OperationCallable<ResizeReservationRequest,Operation,Operation> resizeOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   ResizeReservationRequest request =
       ResizeReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservation("reservation-1563081780")
           .setReservationsResizeRequestResource(ReservationsResizeRequest.newBuilder().build())
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       reservationsClient.resizeOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<ResizeReservationRequest,Operation,Operation>

setIamPolicy(SetIamPolicyReservationRequest request)

public final Policy setIamPolicy(SetIamPolicyReservationRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   SetIamPolicyReservationRequest request =
       SetIamPolicyReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .setZoneSetPolicyRequestResource(ZoneSetPolicyRequest.newBuilder().build())
           .build();
   Policy response = reservationsClient.setIamPolicy(request);
 }
Parameter
Name Description
request SetIamPolicyReservationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Policy

setIamPolicy(String project, String zone, String resource, ZoneSetPolicyRequest zoneSetPolicyRequestResource)

public final Policy setIamPolicy(String project, String zone, String resource, ZoneSetPolicyRequest zoneSetPolicyRequestResource)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String resource = "resource-341064690";
   ZoneSetPolicyRequest zoneSetPolicyRequestResource = ZoneSetPolicyRequest.newBuilder().build();
   Policy response =
       reservationsClient.setIamPolicy(project, zone, resource, zoneSetPolicyRequestResource);
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

The name of the zone for this request.
resource String

Name or id of the resource for this request.
zoneSetPolicyRequestResource ZoneSetPolicyRequest

The body resource for this request
Returns
Type Description
Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyReservationRequest,Policy> setIamPolicyCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   SetIamPolicyReservationRequest request =
       SetIamPolicyReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .setZoneSetPolicyRequestResource(ZoneSetPolicyRequest.newBuilder().build())
           .build();
   ApiFuture<Policy> future = reservationsClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<SetIamPolicyReservationRequest,Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsReservationRequest request)

public final TestPermissionsResponse testIamPermissions(TestIamPermissionsReservationRequest request)

Returns permissions that a caller has on the specified resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   TestIamPermissionsReservationRequest request =
       TestIamPermissionsReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .setZone("zone3744684")
           .build();
   TestPermissionsResponse response = reservationsClient.testIamPermissions(request);
 }
Parameter
Name Description
request TestIamPermissionsReservationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TestPermissionsResponse

testIamPermissions(String project, String zone, String resource, TestPermissionsRequest testPermissionsRequestResource)

public final TestPermissionsResponse testIamPermissions(String project, String zone, String resource, TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String resource = "resource-341064690";
   TestPermissionsRequest testPermissionsRequestResource =
       TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response =
       reservationsClient.testIamPermissions(
           project, zone, resource, testPermissionsRequestResource);
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

The name of the zone for this request.
resource String

Name or id of the resource for this request.
testPermissionsRequestResource TestPermissionsRequest

The body resource for this request
Returns
Type Description
TestPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsReservationRequest,TestPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   TestIamPermissionsReservationRequest request =
       TestIamPermissionsReservationRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .setZone("zone3744684")
           .build();
   ApiFuture<TestPermissionsResponse> future =
       reservationsClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestPermissionsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<TestIamPermissionsReservationRequest,TestPermissionsResponse>

updateAsync(UpdateReservationRequest request)

public final OperationFuture<Operation,Operation> updateAsync(UpdateReservationRequest request)

Update share settings of the reservation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   UpdateReservationRequest request =
       UpdateReservationRequest.newBuilder()
           .setPaths("paths106438894")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservation("reservation-1563081780")
           .setReservationResource(Reservation.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .setZone("zone3744684")
           .build();
   Operation response = reservationsClient.updateAsync(request).get();
 }
Parameter
Name Description
request UpdateReservationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

updateAsync(String project, String zone, String reservation, Reservation reservationResource)

public final OperationFuture<Operation,Operation> updateAsync(String project, String zone, String reservation, Reservation reservationResource)

Update share settings of the reservation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String reservation = "reservation-1563081780";
   Reservation reservationResource = Reservation.newBuilder().build();
   Operation response =
       reservationsClient.updateAsync(project, zone, reservation, reservationResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone for this request.
reservation String

Name of the reservation to update.
reservationResource Reservation

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

updateCallable()

public final UnaryCallable<UpdateReservationRequest,Operation> updateCallable()

Update share settings of the reservation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   UpdateReservationRequest request =
       UpdateReservationRequest.newBuilder()
           .setPaths("paths106438894")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservation("reservation-1563081780")
           .setReservationResource(Reservation.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = reservationsClient.updateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateReservationRequest,Operation>

updateOperationCallable()

public final OperationCallable<UpdateReservationRequest,Operation,Operation> updateOperationCallable()

Update share settings of the reservation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReservationsClient reservationsClient = ReservationsClient.create()) {
   UpdateReservationRequest request =
       UpdateReservationRequest.newBuilder()
           .setPaths("paths106438894")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservation("reservation-1563081780")
           .setReservationResource(Reservation.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       reservationsClient.updateOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<UpdateReservationRequest,Operation,Operation>