@Generated(value="by gapic-generator-java") public class ReservationBlocksClient extends Object implements com.google.api.gax.core.BackgroundResource
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().
| 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
| Modifier and Type | Class and Description |
|---|---|
static class |
ReservationBlocksClient.ListFixedSizeCollection |
static class |
ReservationBlocksClient.ListPage |
static class |
ReservationBlocksClient.ListPagedResponse |
| Modifier | Constructor and Description |
|---|---|
protected |
ReservationBlocksClient(ReservationBlocksSettings settings)
Constructs an instance of ReservationBlocksClient, using the given settings.
|
protected |
ReservationBlocksClient(ReservationBlocksStub stub) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
void |
close() |
static ReservationBlocksClient |
create()
Constructs an instance of ReservationBlocksClient with default settings.
|
static ReservationBlocksClient |
create(ReservationBlocksSettings settings)
Constructs an instance of ReservationBlocksClient, using the given settings.
|
static ReservationBlocksClient |
create(ReservationBlocksStub stub)
Constructs an instance of ReservationBlocksClient, using the given stub for making calls.
|
ReservationBlocksGetResponse |
get(GetReservationBlockRequest request)
Retrieves information about the specified reservation block.
|
ReservationBlocksGetResponse |
get(String project,
String zone,
String reservation,
String reservationBlock)
Retrieves information about the specified reservation block.
|
com.google.api.gax.rpc.UnaryCallable<GetReservationBlockRequest,ReservationBlocksGetResponse> |
getCallable()
Retrieves information about the specified reservation block.
|
ReservationBlocksSettings |
getSettings() |
ReservationBlocksStub |
getStub() |
boolean |
isShutdown() |
boolean |
isTerminated() |
ReservationBlocksClient.ListPagedResponse |
list(ListReservationBlocksRequest request)
Retrieves a list of reservation blocks under a single reservation.
|
ReservationBlocksClient.ListPagedResponse |
list(String project,
String zone,
String reservation)
Retrieves a list of reservation blocks under a single reservation.
|
com.google.api.gax.rpc.UnaryCallable<ListReservationBlocksRequest,ReservationBlocksListResponse> |
listCallable()
Retrieves a list of reservation blocks under a single reservation.
|
com.google.api.gax.rpc.UnaryCallable<ListReservationBlocksRequest,ReservationBlocksClient.ListPagedResponse> |
listPagedCallable()
Retrieves a list of reservation blocks under a single reservation.
|
com.google.api.gax.longrunning.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();
}
|
com.google.api.gax.longrunning.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();
}
|
com.google.api.gax.rpc.UnaryCallable<PerformMaintenanceReservationBlockRequest,Operation> |
performMaintenanceCallable()
Allows customers to perform maintenance on a reservation block
Sample code:
{@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
|
com.google.api.gax.rpc.OperationCallable<PerformMaintenanceReservationBlockRequest,Operation,Operation> |
performMaintenanceOperationCallable()
Allows customers to perform maintenance on a reservation block
Sample code:
{@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
|
void |
shutdown() |
void |
shutdownNow() |
protected ReservationBlocksClient(ReservationBlocksSettings settings) throws IOException
IOExceptionprotected ReservationBlocksClient(ReservationBlocksStub stub)
public static final ReservationBlocksClient create() throws IOException
IOExceptionpublic static final ReservationBlocksClient create(ReservationBlocksSettings settings) throws IOException
IOExceptionpublic static final ReservationBlocksClient create(ReservationBlocksStub stub)
public final ReservationBlocksSettings getSettings()
public ReservationBlocksStub getStub()
public final ReservationBlocksGetResponse get(String project, String zone, String reservation, String reservationBlock)
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);
}
project - Project ID for this request.zone - Name of the zone for this request. Zone name should conform to RFC1035.reservation - The name of the reservation. Name should conform to RFC1035 or be a resource
ID.reservationBlock - The name of the reservation block. Name should conform to RFC1035 or be
a resource ID.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ReservationBlocksGetResponse get(GetReservationBlockRequest request)
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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetReservationBlockRequest,ReservationBlocksGetResponse> getCallable()
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();
}
public final ReservationBlocksClient.ListPagedResponse list(String project, String zone, String 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);
}
}
project - Project ID for this request.zone - Name of the zone for this request. Zone name should conform to RFC1035.reservation - The name of the reservation. Name should conform to RFC1035 or be a resource
ID.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ReservationBlocksClient.ListPagedResponse list(ListReservationBlocksRequest request)
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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListReservationBlocksRequest,ReservationBlocksClient.ListPagedResponse> listPagedCallable()
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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListReservationBlocksRequest,ReservationBlocksListResponse> listCallable()
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;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> performMaintenanceAsync(String project, String zone, String reservation, String reservationBlock, ReservationsBlocksPerformMaintenanceRequest reservationsBlocksPerformMaintenanceRequestResource)
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();
}
project - Project ID for this request.zone - Name of the zone for this request. Zone name should conform to RFC1035.reservation - The name of the reservation. Name should conform to RFC1035 or be a resource
ID.reservationBlock - The name of the reservation block. Name should conform to RFC1035 or be
a resource ID.reservationsBlocksPerformMaintenanceRequestResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> performMaintenanceAsync(PerformMaintenanceReservationBlockRequest request)
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();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<PerformMaintenanceReservationBlockRequest,Operation,Operation> performMaintenanceOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<PerformMaintenanceReservationBlockRequest,Operation> performMaintenanceCallable()
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();
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2025 Google LLC. All rights reserved.