Class ReservationSubBlocksClient (1.74.0)

GitHub RepositoryProduct Reference

Service Description: The ReservationSubBlocks API.

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


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

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

Methods
Method Description Method Variants

Get

Retrieves information about the specified reservation subBlock.

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

  • get(GetReservationSubBlockRequest request)

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

  • get(String project, String zone, String parentName, String reservationSubBlock)

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

  • getCallable()

List

Retrieves a list of reservation subBlocks under a single reservation.

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

  • list(ListReservationSubBlocksRequest request)

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

  • list(String project, String zone, String parentName)

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

  • listPagedCallable()

  • listCallable()

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 ReservationSubBlocksSettings 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
 ReservationSubBlocksSettings reservationSubBlocksSettings =
     ReservationSubBlocksSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ReservationSubBlocksClient reservationSubBlocksClient =
     ReservationSubBlocksClient.create(reservationSubBlocksSettings);

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
 ReservationSubBlocksSettings reservationSubBlocksSettings =
     ReservationSubBlocksSettings.newBuilder().setEndpoint(myEndpoint).build();
 ReservationSubBlocksClient reservationSubBlocksClient =
     ReservationSubBlocksClient.create(reservationSubBlocksSettings);

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

Inheritance

java.lang.Object > ReservationSubBlocksClient

Static Methods

create()

public static final ReservationSubBlocksClient create()

Constructs an instance of ReservationSubBlocksClient with default settings.

Returns
Type Description
ReservationSubBlocksClient
Exceptions
Type Description
IOException

create(ReservationSubBlocksSettings settings)

public static final ReservationSubBlocksClient create(ReservationSubBlocksSettings settings)

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

Parameter
Name Description
settings ReservationSubBlocksSettings
Returns
Type Description
ReservationSubBlocksClient
Exceptions
Type Description
IOException

create(ReservationSubBlocksStub stub)

public static final ReservationSubBlocksClient create(ReservationSubBlocksStub stub)

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

Parameter
Name Description
stub ReservationSubBlocksStub
Returns
Type Description
ReservationSubBlocksClient

Constructors

ReservationSubBlocksClient(ReservationSubBlocksSettings settings)

protected ReservationSubBlocksClient(ReservationSubBlocksSettings settings)

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

Parameter
Name Description
settings ReservationSubBlocksSettings

ReservationSubBlocksClient(ReservationSubBlocksStub stub)

protected ReservationSubBlocksClient(ReservationSubBlocksStub stub)
Parameter
Name Description
stub ReservationSubBlocksStub

Methods

awaitTermination(long duration, TimeUnit unit)

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

close()

public final void close()

get(GetReservationSubBlockRequest request)

public final ReservationSubBlocksGetResponse get(GetReservationSubBlockRequest request)

Retrieves information about the specified reservation subBlock.

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 (ReservationSubBlocksClient reservationSubBlocksClient =
     ReservationSubBlocksClient.create()) {
   GetReservationSubBlockRequest request =
       GetReservationSubBlockRequest.newBuilder()
           .setParentName("parentName-244870571")
           .setProject("project-309310695")
           .setReservationSubBlock("reservationSubBlock-1816847847")
           .setZone("zone3744684")
           .build();
   ReservationSubBlocksGetResponse response = reservationSubBlocksClient.get(request);
 }
Parameter
Name Description
request GetReservationSubBlockRequest

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

get(String project, String zone, String parentName, String reservationSubBlock)

public final ReservationSubBlocksGetResponse get(String project, String zone, String parentName, String reservationSubBlock)

Retrieves information about the specified reservation subBlock.

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 (ReservationSubBlocksClient reservationSubBlocksClient =
     ReservationSubBlocksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String parentName = "parentName-244870571";
   String reservationSubBlock = "reservationSubBlock-1816847847";
   ReservationSubBlocksGetResponse response =
       reservationSubBlocksClient.get(project, zone, parentName, reservationSubBlock);
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

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

The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
reservationSubBlock String

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

getCallable()

public final UnaryCallable<GetReservationSubBlockRequest,ReservationSubBlocksGetResponse> getCallable()

Retrieves information about the specified reservation subBlock.

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 (ReservationSubBlocksClient reservationSubBlocksClient =
     ReservationSubBlocksClient.create()) {
   GetReservationSubBlockRequest request =
       GetReservationSubBlockRequest.newBuilder()
           .setParentName("parentName-244870571")
           .setProject("project-309310695")
           .setReservationSubBlock("reservationSubBlock-1816847847")
           .setZone("zone3744684")
           .build();
   ApiFuture<ReservationSubBlocksGetResponse> future =
       reservationSubBlocksClient.getCallable().futureCall(request);
   // Do something.
   ReservationSubBlocksGetResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<GetReservationSubBlockRequest,ReservationSubBlocksGetResponse>

getSettings()

public final ReservationSubBlocksSettings getSettings()
Returns
Type Description
ReservationSubBlocksSettings

getStub()

public ReservationSubBlocksStub getStub()
Returns
Type Description
ReservationSubBlocksStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListReservationSubBlocksRequest request)

public final ReservationSubBlocksClient.ListPagedResponse list(ListReservationSubBlocksRequest request)

Retrieves a list of reservation subBlocks under a single reservation.

Sample code:


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

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

list(String project, String zone, String parentName)

public final ReservationSubBlocksClient.ListPagedResponse list(String project, String zone, String parentName)

Retrieves a list of reservation subBlocks under a single reservation.

Sample code:


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

Project ID for this request.
zone String

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

The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Returns
Type Description
ReservationSubBlocksClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListReservationSubBlocksRequest,ReservationSubBlocksListResponse> listCallable()

Retrieves a list of reservation subBlocks under a single reservation.

Sample code:


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

listPagedCallable()

public final UnaryCallable<ListReservationSubBlocksRequest,ReservationSubBlocksClient.ListPagedResponse> listPagedCallable()

Retrieves a list of reservation subBlocks under a single reservation.

Sample code:


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

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()