Class ReservationBlocksClient (1.73.0)

GitHub RepositoryProduct Reference

Service Description: The ReservationBlocks 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 (ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String reservation = "reservation-1563081780";
   String reservationBlock = "reservationBlock-1897000927";
   ReservationBlocksGetResponse response =
       reservationBlocksClient.get(project, zone, reservation, reservationBlock);
 }

Note: close() needs to be called on the ReservationBlocksClient 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

Get

Retrieves information about the specified reservation block.

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

  • get(GetReservationBlockRequest 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, String reservationBlock)

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

  • getCallable()

List

Retrieves a list of reservation blocks under a single reservation.

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

  • list(ListReservationBlocksRequest 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, 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.

  • listPagedCallable()

  • listCallable()

PerformMaintenance

Allows customers to perform maintenance on a reservation block

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

  • performMaintenanceAsync(PerformMaintenanceReservationBlockRequest request)

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

  • performMaintenanceAsync(String project, String zone, String reservation, String reservationBlock, ReservationsBlocksPerformMaintenanceRequest reservationsBlocksPerformMaintenanceRequestResource)

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

  • performMaintenanceOperationCallable()

  • performMaintenanceCallable()

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 ReservationBlocksSettings 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
 ReservationBlocksSettings reservationBlocksSettings =
     ReservationBlocksSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ReservationBlocksClient reservationBlocksClient =
     ReservationBlocksClient.create(reservationBlocksSettings);

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
 ReservationBlocksSettings reservationBlocksSettings =
     ReservationBlocksSettings.newBuilder().setEndpoint(myEndpoint).build();
 ReservationBlocksClient reservationBlocksClient =
     ReservationBlocksClient.create(reservationBlocksSettings);

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

Inheritance

java.lang.Object > ReservationBlocksClient

Static Methods

create()

public static final ReservationBlocksClient create()

Constructs an instance of ReservationBlocksClient with default settings.

Returns
Type Description
ReservationBlocksClient
Exceptions
Type Description
IOException

create(ReservationBlocksSettings settings)

public static final ReservationBlocksClient create(ReservationBlocksSettings settings)

Constructs an instance of ReservationBlocksClient, 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 ReservationBlocksSettings
Returns
Type Description
ReservationBlocksClient
Exceptions
Type Description
IOException

create(ReservationBlocksStub stub)

public static final ReservationBlocksClient create(ReservationBlocksStub stub)

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

Parameter
Name Description
stub ReservationBlocksStub
Returns
Type Description
ReservationBlocksClient

Constructors

ReservationBlocksClient(ReservationBlocksSettings settings)

protected ReservationBlocksClient(ReservationBlocksSettings settings)

Constructs an instance of ReservationBlocksClient, 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 ReservationBlocksSettings

ReservationBlocksClient(ReservationBlocksStub stub)

protected ReservationBlocksClient(ReservationBlocksStub stub)
Parameter
Name Description
stub ReservationBlocksStub

Methods

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()

get(GetReservationBlockRequest request)

public final ReservationBlocksGetResponse get(GetReservationBlockRequest request)

Retrieves information about the specified reservation block.

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 (ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.create()) {
   GetReservationBlockRequest request =
       GetReservationBlockRequest.newBuilder()
           .setProject("project-309310695")
           .setReservation("reservation-1563081780")
           .setReservationBlock("reservationBlock-1897000927")
           .setZone("zone3744684")
           .build();
   ReservationBlocksGetResponse response = reservationBlocksClient.get(request);
 }
Parameter
Name Description
request GetReservationBlockRequest

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

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

public final ReservationBlocksGetResponse get(String project, String zone, String reservation, String reservationBlock)

Retrieves information about the specified reservation block.

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 (ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String reservation = "reservation-1563081780";
   String reservationBlock = "reservationBlock-1897000927";
   ReservationBlocksGetResponse response =
       reservationBlocksClient.get(project, zone, reservation, reservationBlock);
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone for this request. Zone name should conform to RFC1035.
reservation String

The name of the reservation. Name should conform to RFC1035 or be a resource ID.
reservationBlock String

The name of the reservation block. Name should conform to RFC1035 or be a resource ID.
Returns
Type Description
ReservationBlocksGetResponse

getCallable()

public final UnaryCallable<GetReservationBlockRequest,ReservationBlocksGetResponse> getCallable()

Retrieves information about the specified reservation block.

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 (ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.create()) {
   GetReservationBlockRequest request =
       GetReservationBlockRequest.newBuilder()
           .setProject("project-309310695")
           .setReservation("reservation-1563081780")
           .setReservationBlock("reservationBlock-1897000927")
           .setZone("zone3744684")
           .build();
   ApiFuture<ReservationBlocksGetResponse> future =
       reservationBlocksClient.getCallable().futureCall(request);
   // Do something.
   ReservationBlocksGetResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<GetReservationBlockRequest,ReservationBlocksGetResponse>

getSettings()

public final ReservationBlocksSettings getSettings()
Returns
Type Description
ReservationBlocksSettings

getStub()

public ReservationBlocksStub getStub()
Returns
Type Description
ReservationBlocksStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListReservationBlocksRequest request)

public final ReservationBlocksClient.ListPagedResponse list(ListReservationBlocksRequest request)

Retrieves a list of reservation blocks under a single 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 (ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.create()) {
   ListReservationBlocksRequest request =
       ListReservationBlocksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReservation("reservation-1563081780")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (ReservationBlock element : reservationBlocksClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListReservationBlocksRequest

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

list(String project, String zone, String reservation)

public final ReservationBlocksClient.ListPagedResponse list(String project, String zone, String reservation)

Retrieves a list of reservation blocks under a single 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 (ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String reservation = "reservation-1563081780";
   for (ReservationBlock element :
       reservationBlocksClient.list(project, zone, reservation).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone for this request. Zone name should conform to RFC1035.
reservation String

The name of the reservation. Name should conform to RFC1035 or be a resource ID.
Returns
Type Description
ReservationBlocksClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListReservationBlocksRequest,ReservationBlocksListResponse> listCallable()

Retrieves a list of reservation blocks under a single 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 (ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.create()) {
   ListReservationBlocksRequest request =
       ListReservationBlocksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReservation("reservation-1563081780")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     ReservationBlocksListResponse response =
         reservationBlocksClient.listCallable().call(request);
     for (ReservationBlock 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<ListReservationBlocksRequest,ReservationBlocksListResponse>

listPagedCallable()

public final UnaryCallable<ListReservationBlocksRequest,ReservationBlocksClient.ListPagedResponse> listPagedCallable()

Retrieves a list of reservation blocks under a single 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 (ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.create()) {
   ListReservationBlocksRequest request =
       ListReservationBlocksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReservation("reservation-1563081780")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture<ReservationBlock> future =
       reservationBlocksClient.listPagedCallable().futureCall(request);
   // Do something.
   for (ReservationBlock element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListReservationBlocksRequest,ListPagedResponse>

performMaintenanceAsync(PerformMaintenanceReservationBlockRequest request)

public final OperationFuture<Operation,Operation> performMaintenanceAsync(PerformMaintenanceReservationBlockRequest request)

Allows customers to perform maintenance on a reservation block

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 (ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.create()) {
   PerformMaintenanceReservationBlockRequest request =
       PerformMaintenanceReservationBlockRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservation("reservation-1563081780")
           .setReservationBlock("reservationBlock-1897000927")
           .setReservationsBlocksPerformMaintenanceRequestResource(
               ReservationsBlocksPerformMaintenanceRequest.newBuilder().build())
           .setZone("zone3744684")
           .build();
   Operation response = reservationBlocksClient.performMaintenanceAsync(request).get();
 }
Parameter
Name Description
request PerformMaintenanceReservationBlockRequest

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

performMaintenanceAsync(String project, String zone, String reservation, String reservationBlock, ReservationsBlocksPerformMaintenanceRequest reservationsBlocksPerformMaintenanceRequestResource)

public final OperationFuture<Operation,Operation> performMaintenanceAsync(String project, String zone, String reservation, String reservationBlock, ReservationsBlocksPerformMaintenanceRequest reservationsBlocksPerformMaintenanceRequestResource)

Allows customers to perform maintenance on a reservation block

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 (ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String reservation = "reservation-1563081780";
   String reservationBlock = "reservationBlock-1897000927";
   ReservationsBlocksPerformMaintenanceRequest
       reservationsBlocksPerformMaintenanceRequestResource =
           ReservationsBlocksPerformMaintenanceRequest.newBuilder().build();
   Operation response =
       reservationBlocksClient
           .performMaintenanceAsync(
               project,
               zone,
               reservation,
               reservationBlock,
               reservationsBlocksPerformMaintenanceRequestResource)
           .get();
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone for this request. Zone name should conform to RFC1035.
reservation String

The name of the reservation. Name should conform to RFC1035 or be a resource ID.
reservationBlock String

The name of the reservation block. Name should conform to RFC1035 or be a resource ID.
reservationsBlocksPerformMaintenanceRequestResource ReservationsBlocksPerformMaintenanceRequest

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

performMaintenanceCallable()

public final UnaryCallable<PerformMaintenanceReservationBlockRequest,Operation> performMaintenanceCallable()

Allows customers to perform maintenance on a reservation block

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 (ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.create()) {
   PerformMaintenanceReservationBlockRequest request =
       PerformMaintenanceReservationBlockRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservation("reservation-1563081780")
           .setReservationBlock("reservationBlock-1897000927")
           .setReservationsBlocksPerformMaintenanceRequestResource(
               ReservationsBlocksPerformMaintenanceRequest.newBuilder().build())
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future =
       reservationBlocksClient.performMaintenanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<PerformMaintenanceReservationBlockRequest,Operation>

performMaintenanceOperationCallable()

public final OperationCallable<PerformMaintenanceReservationBlockRequest,Operation,Operation> performMaintenanceOperationCallable()

Allows customers to perform maintenance on a reservation block

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 (ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.create()) {
   PerformMaintenanceReservationBlockRequest request =
       PerformMaintenanceReservationBlockRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setReservation("reservation-1563081780")
           .setReservationBlock("reservationBlock-1897000927")
           .setReservationsBlocksPerformMaintenanceRequestResource(
               ReservationsBlocksPerformMaintenanceRequest.newBuilder().build())
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       reservationBlocksClient.performMaintenanceOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<PerformMaintenanceReservationBlockRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()