Class RegionCommitmentsClient (1.8.1)

Version 1.8.1

• 1.64.0 (latest)
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public class RegionCommitmentsClient implements BackgroundResource

Service Description: The RegionCommitments 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:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String commitment = "commitment1019005717";
   Commitment response = regionCommitmentsClient.get(project, region, commitment);
 }
 

Note: close() needs to be called on the RegionCommitmentsClient 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 RegionCommitmentsSettings to create(). For example:

To customize credentials:

 RegionCommitmentsSettings regionCommitmentsSettings =
     RegionCommitmentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionCommitmentsClient regionCommitmentsClient =
     RegionCommitmentsClient.create(regionCommitmentsSettings);
 

To customize the endpoint:

 RegionCommitmentsSettings regionCommitmentsSettings =
     RegionCommitmentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionCommitmentsClient regionCommitmentsClient =
     RegionCommitmentsClient.create(regionCommitmentsSettings);
 

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

Inheritance

java.lang.Object > RegionCommitmentsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final RegionCommitmentsClient create()

Constructs an instance of RegionCommitmentsClient with default settings.

Returns

Type	Description
RegionCommitmentsClient

Exceptions

Type	Description
IOException

create(RegionCommitmentsSettings settings)

public static final RegionCommitmentsClient create(RegionCommitmentsSettings settings)

Constructs an instance of RegionCommitmentsClient, 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	RegionCommitmentsSettings

Returns

Type	Description
RegionCommitmentsClient

Exceptions

Type	Description
IOException

create(RegionCommitmentsStub stub)

public static final RegionCommitmentsClient create(RegionCommitmentsStub stub)

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

Parameter

Name	Description
stub	RegionCommitmentsStub

Returns

Type	Description
RegionCommitmentsClient

Constructors

RegionCommitmentsClient(RegionCommitmentsSettings settings)

protected RegionCommitmentsClient(RegionCommitmentsSettings settings)

Constructs an instance of RegionCommitmentsClient, 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	RegionCommitmentsSettings

RegionCommitmentsClient(RegionCommitmentsStub stub)

protected RegionCommitmentsClient(RegionCommitmentsStub stub)

Parameter

Name	Description
stub	RegionCommitmentsStub

Methods

aggregatedList(AggregatedListRegionCommitmentsRequest request)

public final RegionCommitmentsClient.AggregatedListPagedResponse aggregatedList(AggregatedListRegionCommitmentsRequest request)

Retrieves an aggregated list of commitments by region.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   AggregatedListRegionCommitmentsRequest request =
       AggregatedListRegionCommitmentsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Map.Entry

Parameter

Name	Description
request	AggregatedListRegionCommitmentsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
RegionCommitmentsClient.AggregatedListPagedResponse

aggregatedList(String project)

public final RegionCommitmentsClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of commitments by region.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   String project = "project-309310695";
   for (Map.Entry

Parameter

Name	Description
project	String Project ID for this request.

Returns

Type	Description
RegionCommitmentsClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListRegionCommitmentsRequest,CommitmentAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of commitments by region.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   AggregatedListRegionCommitmentsRequest request =
       AggregatedListRegionCommitmentsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     CommitmentAggregatedList response =
         regionCommitmentsClient.aggregatedListCallable().call(request);
     for (Map.Entry

Returns

Type	Description
UnaryCallable<AggregatedListRegionCommitmentsRequest,CommitmentAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListRegionCommitmentsRequest,RegionCommitmentsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of commitments by region.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   AggregatedListRegionCommitmentsRequest request =
       AggregatedListRegionCommitmentsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<>

Returns

Type	Description
UnaryCallable<AggregatedListRegionCommitmentsRequest,AggregatedListPagedResponse>

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

public final Commitment get(GetRegionCommitmentRequest request)

Returns the specified commitment resource. Gets a list of available commitments by making a list() request.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   GetRegionCommitmentRequest request =
       GetRegionCommitmentRequest.newBuilder()
           .setCommitment("commitment1019005717")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   Commitment response = regionCommitmentsClient.get(request);
 }
 

Parameter

Name	Description
request	GetRegionCommitmentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Commitment

get(String project, String region, String commitment)

public final Commitment get(String project, String region, String commitment)

Returns the specified commitment resource. Gets a list of available commitments by making a list() request.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String commitment = "commitment1019005717";
   Commitment response = regionCommitmentsClient.get(project, region, commitment);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
commitment	String Name of the commitment to return.

Returns

Type	Description
Commitment

getCallable()

public final UnaryCallable<GetRegionCommitmentRequest,Commitment> getCallable()

Returns the specified commitment resource. Gets a list of available commitments by making a list() request.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   GetRegionCommitmentRequest request =
       GetRegionCommitmentRequest.newBuilder()
           .setCommitment("commitment1019005717")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<Commitment> future = regionCommitmentsClient.getCallable().futureCall(request);
   // Do something.
   Commitment response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetRegionCommitmentRequest,Commitment>

getSettings()

public final RegionCommitmentsSettings getSettings()

Returns

Type	Description
RegionCommitmentsSettings

getStub()

public RegionCommitmentsStub getStub()

Returns

Type	Description
RegionCommitmentsStub

insertAsync(InsertRegionCommitmentRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertRegionCommitmentRequest request)

Creates a commitment in the specified project using the data included in the request.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   InsertRegionCommitmentRequest request =
       InsertRegionCommitmentRequest.newBuilder()
           .setCommitmentResource(Commitment.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionCommitmentsClient.insertAsync(request).get();
 }
 

Parameter

Name	Description
request	InsertRegionCommitmentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, Commitment commitmentResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, Commitment commitmentResource)

Creates a commitment in the specified project using the data included in the request.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   Commitment commitmentResource = Commitment.newBuilder().build();
   Operation response =
       regionCommitmentsClient.insertAsync(project, region, commitmentResource).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
commitmentResource	Commitment The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertRegionCommitmentRequest,Operation> insertCallable()

Creates a commitment in the specified project using the data included in the request.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   InsertRegionCommitmentRequest request =
       InsertRegionCommitmentRequest.newBuilder()
           .setCommitmentResource(Commitment.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = regionCommitmentsClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<InsertRegionCommitmentRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertRegionCommitmentRequest,Operation,Operation> insertOperationCallable()

Creates a commitment in the specified project using the data included in the request.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   InsertRegionCommitmentRequest request =
       InsertRegionCommitmentRequest.newBuilder()
           .setCommitmentResource(Commitment.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<InsertRegionCommitmentRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListRegionCommitmentsRequest request)

public final RegionCommitmentsClient.ListPagedResponse list(ListRegionCommitmentsRequest request)

Retrieves a list of commitments contained within the specified region.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   ListRegionCommitmentsRequest request =
       ListRegionCommitmentsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (Commitment element : regionCommitmentsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListRegionCommitmentsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
RegionCommitmentsClient.ListPagedResponse

list(String project, String region)

public final RegionCommitmentsClient.ListPagedResponse list(String project, String region)

Retrieves a list of commitments contained within the specified region.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (Commitment element : regionCommitmentsClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.

Returns

Type	Description
RegionCommitmentsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListRegionCommitmentsRequest,CommitmentList> listCallable()

Retrieves a list of commitments contained within the specified region.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   ListRegionCommitmentsRequest request =
       ListRegionCommitmentsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     CommitmentList response = regionCommitmentsClient.listCallable().call(request);
     for (Commitment element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListRegionCommitmentsRequest,CommitmentList>

listPagedCallable()

public final UnaryCallable<ListRegionCommitmentsRequest,RegionCommitmentsClient.ListPagedResponse> listPagedCallable()

Retrieves a list of commitments contained within the specified region.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   ListRegionCommitmentsRequest request =
       ListRegionCommitmentsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Commitment> future =
       regionCommitmentsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (Commitment element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListRegionCommitmentsRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAsync(UpdateRegionCommitmentRequest request)

public final OperationFuture<Operation,Operation> updateAsync(UpdateRegionCommitmentRequest request)

Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   UpdateRegionCommitmentRequest request =
       UpdateRegionCommitmentRequest.newBuilder()
           .setCommitment("commitment1019005717")
           .setCommitmentResource(Commitment.newBuilder().build())
           .setPaths("paths106438894")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setUpdateMask("updateMask-296147115")
           .build();
   Operation response = regionCommitmentsClient.updateAsync(request).get();
 }
 

Parameter

Name	Description
request	UpdateRegionCommitmentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Operation,Operation>

updateAsync(String project, String region, String commitment, Commitment commitmentResource)

public final OperationFuture<Operation,Operation> updateAsync(String project, String region, String commitment, Commitment commitmentResource)

Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String commitment = "commitment1019005717";
   Commitment commitmentResource = Commitment.newBuilder().build();
   Operation response =
       regionCommitmentsClient
           .updateAsync(project, region, commitment, commitmentResource)
           .get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
commitment	String Name of the commitment for which auto renew is being updated.
commitmentResource	Commitment The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

updateCallable()

public final UnaryCallable<UpdateRegionCommitmentRequest,Operation> updateCallable()

Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   UpdateRegionCommitmentRequest request =
       UpdateRegionCommitmentRequest.newBuilder()
           .setCommitment("commitment1019005717")
           .setCommitmentResource(Commitment.newBuilder().build())
           .setPaths("paths106438894")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setUpdateMask("updateMask-296147115")
           .build();
   ApiFuture<Operation> future = regionCommitmentsClient.updateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateRegionCommitmentRequest,Operation>

updateOperationCallable()

public final OperationCallable<UpdateRegionCommitmentRequest,Operation,Operation> updateOperationCallable()

Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.

Sample code:

 try (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) {
   UpdateRegionCommitmentRequest request =
       UpdateRegionCommitmentRequest.newBuilder()
           .setCommitment("commitment1019005717")
           .setCommitmentResource(Commitment.newBuilder().build())
           .setPaths("paths106438894")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setUpdateMask("updateMask-296147115")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<UpdateRegionCommitmentRequest,Operation,Operation>