ReservationClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.ReservationClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class ReservationClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: Creates and runs virtual machines on Google Cloud Platform.
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:
```
 
 try (ReservationClient reservationClient = ReservationClient.create()) {
   ProjectZoneReservationName reservation = ProjectZoneReservationName.of("[PROJECT]", "[ZONE]", "[RESERVATION]");
   Operation response = reservationClient.deleteReservation(reservation);
 }
 
 
```
Note: close() needs to be called on the reservationClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns 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 ReservationSettings to create(). For example:
To customize credentials:
```
 
 ReservationSettings reservationSettings =
     ReservationSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ReservationClient reservationClient =
     ReservationClient.create(reservationSettings);
 
 
```
To customize the endpoint:
```
 
 ReservationSettings reservationSettings =
     ReservationSettings.newBuilder().setEndpoint(myEndpoint).build();
 ReservationClient reservationClient =
     ReservationClient.create(reservationSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ReservationClient.AggregatedListReservationsFixedSizeCollection`
`static class`	`ReservationClient.AggregatedListReservationsPage`
`static class`	`ReservationClient.AggregatedListReservationsPagedResponse`
`static class`	`ReservationClient.ListReservationsFixedSizeCollection`
`static class`	`ReservationClient.ListReservationsPage`
`static class`	`ReservationClient.ListReservationsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ReservationClient(ReservationSettings settings)` Constructs an instance of ReservationClient, using the given settings.
`protected`	`ReservationClient(ReservationStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReservationClient.AggregatedListReservationsPagedResponse`	`aggregatedListReservations(AggregatedListReservationsHttpRequest request)` Retrieves an aggregated list of reservations.
`ReservationClient.AggregatedListReservationsPagedResponse`	`aggregatedListReservations(ProjectName project)` Retrieves an aggregated list of reservations.
`ReservationClient.AggregatedListReservationsPagedResponse`	`aggregatedListReservations(String project)` Retrieves an aggregated list of reservations.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListReservationsHttpRequest,ReservationAggregatedList>`	`aggregatedListReservationsCallable()` Retrieves an aggregated list of reservations.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListReservationsHttpRequest,ReservationClient.AggregatedListReservationsPagedResponse>`	`aggregatedListReservationsPagedCallable()` Retrieves an aggregated list of reservations.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ReservationClient`	`create()` Constructs an instance of ReservationClient with default settings.
`static ReservationClient`	`create(ReservationSettings settings)` Constructs an instance of ReservationClient, using the given settings.
`static ReservationClient`	`create(ReservationStub stub)` Constructs an instance of ReservationClient, using the given stub for making calls.
`Operation`	`deleteReservation(DeleteReservationHttpRequest request)` Deletes the specified reservation.
`Operation`	`deleteReservation(ProjectZoneReservationName reservation)` Deletes the specified reservation.
`Operation`	`deleteReservation(String reservation)` Deletes the specified reservation.
`com.google.api.gax.rpc.UnaryCallable<DeleteReservationHttpRequest,Operation>`	`deleteReservationCallable()` Deletes the specified reservation.
`Policy`	`getIamPolicyReservation(GetIamPolicyReservationHttpRequest request)` Gets the access control policy for a resource.
`Policy`	`getIamPolicyReservation(ProjectZoneReservationResourceName resource)` Gets the access control policy for a resource.
`Policy`	`getIamPolicyReservation(String resource)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<GetIamPolicyReservationHttpRequest,Policy>`	`getIamPolicyReservationCallable()` Gets the access control policy for a resource.
`Reservation`	`getReservation(GetReservationHttpRequest request)` Retrieves information about the specified reservation.
`Reservation`	`getReservation(ProjectZoneReservationName reservation)` Retrieves information about the specified reservation.
`Reservation`	`getReservation(String reservation)` Retrieves information about the specified reservation.
`com.google.api.gax.rpc.UnaryCallable<GetReservationHttpRequest,Reservation>`	`getReservationCallable()` Retrieves information about the specified reservation.
`ReservationSettings`	`getSettings()`
`ReservationStub`	`getStub()`
`Operation`	`insertReservation(InsertReservationHttpRequest request)` Creates a new reservation.
`Operation`	`insertReservation(ProjectZoneName zone, Reservation reservationResource)` Creates a new reservation.
`Operation`	`insertReservation(String zone, Reservation reservationResource)` Creates a new reservation.
`com.google.api.gax.rpc.UnaryCallable<InsertReservationHttpRequest,Operation>`	`insertReservationCallable()` Creates a new reservation.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ReservationClient.ListReservationsPagedResponse`	`listReservations(ListReservationsHttpRequest request)` A list of all the reservations that have been configured for the specified project in specified zone.
`ReservationClient.ListReservationsPagedResponse`	`listReservations(ProjectZoneName zone)` A list of all the reservations that have been configured for the specified project in specified zone.
`ReservationClient.ListReservationsPagedResponse`	`listReservations(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<ListReservationsHttpRequest,ReservationList>`	`listReservationsCallable()` A list of all the reservations that have been configured for the specified project in specified zone.
`com.google.api.gax.rpc.UnaryCallable<ListReservationsHttpRequest,ReservationClient.ListReservationsPagedResponse>`	`listReservationsPagedCallable()` A list of all the reservations that have been configured for the specified project in specified zone.
`Operation`	`resizeReservation(ProjectZoneReservationName reservation, ReservationsResizeRequest reservationsResizeRequestResource)` Resizes the reservation (applicable to standalone reservations only).
`Operation`	`resizeReservation(ResizeReservationHttpRequest request)` Resizes the reservation (applicable to standalone reservations only).
`Operation`	`resizeReservation(String reservation, ReservationsResizeRequest reservationsResizeRequestResource)` Resizes the reservation (applicable to standalone reservations only).
`com.google.api.gax.rpc.UnaryCallable<ResizeReservationHttpRequest,Operation>`	`resizeReservationCallable()` Resizes the reservation (applicable to standalone reservations only).
`Policy`	`setIamPolicyReservation(ProjectZoneReservationResourceName resource, ZoneSetPolicyRequest zoneSetPolicyRequestResource)` Sets the access control policy on the specified resource.
`Policy`	`setIamPolicyReservation(SetIamPolicyReservationHttpRequest request)` Sets the access control policy on the specified resource.
`Policy`	`setIamPolicyReservation(String resource, ZoneSetPolicyRequest zoneSetPolicyRequestResource)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<SetIamPolicyReservationHttpRequest,Policy>`	`setIamPolicyReservationCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`TestPermissionsResponse`	`testIamPermissionsReservation(ProjectZoneReservationResourceName resource, TestPermissionsRequest testPermissionsRequestResource)` Returns permissions that a caller has on the specified resource.
`TestPermissionsResponse`	`testIamPermissionsReservation(String resource, TestPermissionsRequest testPermissionsRequestResource)` Returns permissions that a caller has on the specified resource.
`TestPermissionsResponse`	`testIamPermissionsReservation(TestIamPermissionsReservationHttpRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsReservationHttpRequest,TestPermissionsResponse>`	`testIamPermissionsReservationCallable()` Returns permissions that a caller has on the specified resource.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ReservationClient
```
protected ReservationClient(ReservationSettings settings)
                     throws IOException
```
  Constructs an instance of ReservationClient, 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.
  
  Throws:
  
  IOException
- ReservationClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected ReservationClient(ReservationStub stub)
```

Method Detail

create

public static final ReservationClient create()
                                      throws IOException

Constructs an instance of ReservationClient with default settings.

Throws:: IOException

create
```
public static final ReservationClient create(ReservationSettings settings)
                                      throws IOException
```
Constructs an instance of ReservationClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final ReservationClient create(ReservationStub stub)

Constructs an instance of ReservationClient, using the given stub for making calls. This is for advanced usage - prefer to use ReservationSettings}.

getSettings

public final ReservationSettings getSettings()