@Generated(value="by gapic-generator-java") public class ReservationsClient 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 (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().
| 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.
"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.
|
Delete |
Deletes the specified reservation. |
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.
|
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.
"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.
|
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.
"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.
|
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.
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.
|
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.
"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.
|
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.
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.
|
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.
"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.
|
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.
"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.
|
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.
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 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.
| Modifier and Type | Class and Description |
|---|---|
static class |
ReservationsClient.AggregatedListFixedSizeCollection |
static class |
ReservationsClient.AggregatedListPage |
static class |
ReservationsClient.AggregatedListPagedResponse |
static class |
ReservationsClient.ListFixedSizeCollection |
static class |
ReservationsClient.ListPage |
static class |
ReservationsClient.ListPagedResponse |
| Modifier | Constructor and Description |
|---|---|
protected |
ReservationsClient(ReservationsSettings settings)
Constructs an instance of ReservationsClient, using the given settings.
|
protected |
ReservationsClient(ReservationsStub stub) |
| Modifier and Type | Method and Description |
|---|---|
ReservationsClient.AggregatedListPagedResponse |
aggregatedList(AggregatedListReservationsRequest request)
Retrieves an aggregated list of reservations.
|
ReservationsClient.AggregatedListPagedResponse |
aggregatedList(String project)
Retrieves an aggregated list of reservations.
|
com.google.api.gax.rpc.UnaryCallable<AggregatedListReservationsRequest,ReservationAggregatedList> |
aggregatedListCallable()
Retrieves an aggregated list of reservations.
|
com.google.api.gax.rpc.UnaryCallable<AggregatedListReservationsRequest,ReservationsClient.AggregatedListPagedResponse> |
aggregatedListPagedCallable()
Retrieves an aggregated list of reservations.
|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
void |
close() |
static ReservationsClient |
create()
Constructs an instance of ReservationsClient with default settings.
|
static ReservationsClient |
create(ReservationsSettings settings)
Constructs an instance of ReservationsClient, using the given settings.
|
static ReservationsClient |
create(ReservationsStub stub)
Constructs an instance of ReservationsClient, using the given stub for making calls.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
deleteAsync(DeleteReservationRequest request)
Deletes the specified reservation.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
deleteAsync(String project,
String zone,
String reservation)
Deletes the specified reservation.
|
com.google.api.gax.rpc.UnaryCallable<DeleteReservationRequest,Operation> |
deleteCallable()
Deletes the specified reservation.
|
com.google.api.gax.rpc.OperationCallable<DeleteReservationRequest,Operation,Operation> |
deleteOperationCallable()
Deletes the specified reservation.
|
Reservation |
get(GetReservationRequest request)
Retrieves information about the specified reservation.
|
Reservation |
get(String project,
String zone,
String reservation)
Retrieves information about the specified reservation.
|
com.google.api.gax.rpc.UnaryCallable<GetReservationRequest,Reservation> |
getCallable()
Retrieves information about the specified reservation.
|
Policy |
getIamPolicy(GetIamPolicyReservationRequest request)
Gets the access control policy for a resource.
|
Policy |
getIamPolicy(String project,
String zone,
String resource)
Gets the access control policy for a resource.
|
com.google.api.gax.rpc.UnaryCallable<GetIamPolicyReservationRequest,Policy> |
getIamPolicyCallable()
Gets the access control policy for a resource.
|
ReservationsSettings |
getSettings() |
ReservationsStub |
getStub() |
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
insertAsync(InsertReservationRequest request)
Creates a new reservation.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
insertAsync(String project,
String zone,
Reservation reservationResource)
Creates a new reservation.
|
com.google.api.gax.rpc.UnaryCallable<InsertReservationRequest,Operation> |
insertCallable()
Creates a new reservation.
|
com.google.api.gax.rpc.OperationCallable<InsertReservationRequest,Operation,Operation> |
insertOperationCallable()
Creates a new reservation.
|
boolean |
isShutdown() |
boolean |
isTerminated() |
ReservationsClient.ListPagedResponse |
list(ListReservationsRequest request)
A list of all the reservations that have been configured for the specified project in specified
zone.
|
ReservationsClient.ListPagedResponse |
list(String project,
String zone)
A list of all the reservations that have been configured for the specified project in specified
zone.
|
com.google.api.gax.rpc.UnaryCallable<ListReservationsRequest,ReservationList> |
listCallable()
A list of all the reservations that have been configured for the specified project in specified
zone.
|
com.google.api.gax.rpc.UnaryCallable<ListReservationsRequest,ReservationsClient.ListPagedResponse> |
listPagedCallable()
A list of all the reservations that have been configured for the specified project in specified
zone.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
resizeAsync(ResizeReservationRequest request)
Resizes the reservation (applicable to standalone reservations only).
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
resizeAsync(String project,
String zone,
String reservation,
ReservationsResizeRequest reservationsResizeRequestResource)
Resizes the reservation (applicable to standalone reservations only).
|
com.google.api.gax.rpc.UnaryCallable<ResizeReservationRequest,Operation> |
resizeCallable()
Resizes the reservation (applicable to standalone reservations only).
|
com.google.api.gax.rpc.OperationCallable<ResizeReservationRequest,Operation,Operation> |
resizeOperationCallable()
Resizes the reservation (applicable to standalone reservations only).
|
Policy |
setIamPolicy(SetIamPolicyReservationRequest request)
Sets the access control policy on the specified resource.
|
Policy |
setIamPolicy(String project,
String zone,
String resource,
ZoneSetPolicyRequest zoneSetPolicyRequestResource)
Sets the access control policy on the specified resource.
|
com.google.api.gax.rpc.UnaryCallable<SetIamPolicyReservationRequest,Policy> |
setIamPolicyCallable()
Sets the access control policy on the specified resource.
|
void |
shutdown() |
void |
shutdownNow() |
TestPermissionsResponse |
testIamPermissions(String project,
String zone,
String resource,
TestPermissionsRequest testPermissionsRequestResource)
Returns permissions that a caller has on the specified resource.
|
TestPermissionsResponse |
testIamPermissions(TestIamPermissionsReservationRequest request)
Returns permissions that a caller has on the specified resource.
|
com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsReservationRequest,TestPermissionsResponse> |
testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
updateAsync(String project,
String zone,
String reservation,
Reservation reservationResource)
Update share settings of the reservation.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
updateAsync(UpdateReservationRequest request)
Update share settings of the reservation.
|
com.google.api.gax.rpc.UnaryCallable<UpdateReservationRequest,Operation> |
updateCallable()
Update share settings of the reservation.
|
com.google.api.gax.rpc.OperationCallable<UpdateReservationRequest,Operation,Operation> |
updateOperationCallable()
Update share settings of the reservation.
|
protected ReservationsClient(ReservationsSettings settings) throws IOException
IOExceptionprotected ReservationsClient(ReservationsStub stub)
public static final ReservationsClient create() throws IOException
IOExceptionpublic static final ReservationsClient create(ReservationsSettings settings) throws IOException
IOExceptionpublic static final ReservationsClient create(ReservationsStub stub)
public final ReservationsSettings getSettings()
public ReservationsStub getStub()
public final ReservationsClient.AggregatedListPagedResponse aggregatedList(String project)
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);
}
}
project - Project ID for this request.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ReservationsClient.AggregatedListPagedResponse aggregatedList(AggregatedListReservationsRequest 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 (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);
}
}
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<AggregatedListReservationsRequest,ReservationsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListReservationsRequest,ReservationAggregatedList> aggregatedListCallable()
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;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(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 (ReservationsClient reservationsClient = ReservationsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String reservation = "reservation-1563081780";
Operation response = reservationsClient.deleteAsync(project, zone, reservation).get();
}
project - Project ID for this request.zone - Name of the zone for this request.reservation - Name of the reservation to delete.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(DeleteReservationRequest 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 (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();
}
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<DeleteReservationRequest,Operation,Operation> deleteOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<DeleteReservationRequest,Operation> deleteCallable()
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();
}
public final Reservation get(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 (ReservationsClient reservationsClient = ReservationsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String reservation = "reservation-1563081780";
Reservation response = reservationsClient.get(project, zone, reservation);
}
project - Project ID for this request.zone - Name of the zone for this request.reservation - Name of the reservation to retrieve.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Reservation get(GetReservationRequest 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 (ReservationsClient reservationsClient = ReservationsClient.create()) {
GetReservationRequest request =
GetReservationRequest.newBuilder()
.setProject("project-309310695")
.setReservation("reservation-1563081780")
.setZone("zone3744684")
.build();
Reservation response = reservationsClient.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<GetReservationRequest,Reservation> 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 (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();
}
public final Policy getIamPolicy(String project, String zone, String 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";
Policy response = reservationsClient.getIamPolicy(project, zone, resource);
}
project - Project ID for this request.zone - The name of the zone for this request.resource - Name or id of the resource for this request.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Policy getIamPolicy(GetIamPolicyReservationRequest 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 (ReservationsClient reservationsClient = ReservationsClient.create()) {
GetIamPolicyReservationRequest request =
GetIamPolicyReservationRequest.newBuilder()
.setOptionsRequestedPolicyVersion(-574521795)
.setProject("project-309310695")
.setResource("resource-341064690")
.setZone("zone3744684")
.build();
Policy response = reservationsClient.getIamPolicy(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<GetIamPolicyReservationRequest,Policy> getIamPolicyCallable()
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();
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project, String zone, Reservation reservationResource)
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();
}
project - Project ID for this request.zone - Name of the zone for this request.reservationResource - 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> insertAsync(InsertReservationRequest 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 (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();
}
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<InsertReservationRequest,Operation,Operation> insertOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<InsertReservationRequest,Operation> insertCallable()
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();
}
public final ReservationsClient.ListPagedResponse list(String project, String 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);
}
}
project - Project ID for this request.zone - Name of the zone for this request.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ReservationsClient.ListPagedResponse list(ListReservationsRequest 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 (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);
}
}
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<ListReservationsRequest,ReservationsClient.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 (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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListReservationsRequest,ReservationList> 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 (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;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> resizeAsync(String project, String zone, String reservation, ReservationsResizeRequest reservationsResizeRequestResource)
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();
}
project - Project ID for this request.zone - Name of the zone for this request.reservation - Name of the reservation to update.reservationsResizeRequestResource - 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> resizeAsync(ResizeReservationRequest 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 (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();
}
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<ResizeReservationRequest,Operation,Operation> resizeOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<ResizeReservationRequest,Operation> resizeCallable()
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();
}
public final Policy setIamPolicy(String project, String zone, String resource, ZoneSetPolicyRequest zoneSetPolicyRequestResource)
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);
}
project - Project ID for this request.zone - The name of the zone for this request.resource - Name or id of the resource for this request.zoneSetPolicyRequestResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final Policy setIamPolicy(SetIamPolicyReservationRequest 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 (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);
}
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<SetIamPolicyReservationRequest,Policy> setIamPolicyCallable()
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();
}
public final TestPermissionsResponse testIamPermissions(String project, String zone, String resource, TestPermissionsRequest testPermissionsRequestResource)
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);
}
project - Project ID for this request.zone - The name of the zone for this request.resource - Name or id of the resource for this request.testPermissionsRequestResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final TestPermissionsResponse testIamPermissions(TestIamPermissionsReservationRequest 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 (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);
}
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<TestIamPermissionsReservationRequest,TestPermissionsResponse> testIamPermissionsCallable()
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();
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> updateAsync(String project, String zone, String reservation, Reservation reservationResource)
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();
}
project - Project ID for this request.zone - Name of the zone for this request.reservation - Name of the reservation to update.reservationResource - 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> updateAsync(UpdateReservationRequest 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 (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();
}
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<UpdateReservationRequest,Operation,Operation> updateOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<UpdateReservationRequest,Operation> updateCallable()
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();
}
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 © 2024 Google LLC. All rights reserved.