Class RegionCommitmentsClient
- java.lang.Object
-
- com.google.cloud.compute.v1.RegionCommitmentsClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class RegionCommitmentsClient extends Object implements com.google.api.gax.core.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:
// 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 (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:
- 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.
- 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.
- 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:
// 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 RegionCommitmentsSettings regionCommitmentsSettings = RegionCommitmentsSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create(regionCommitmentsSettings);
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 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RegionCommitmentsClient.AggregatedListFixedSizeCollection
static class
RegionCommitmentsClient.AggregatedListPage
static class
RegionCommitmentsClient.AggregatedListPagedResponse
static class
RegionCommitmentsClient.ListFixedSizeCollection
static class
RegionCommitmentsClient.ListPage
static class
RegionCommitmentsClient.ListPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
RegionCommitmentsClient(RegionCommitmentsSettings settings)
Constructs an instance of RegionCommitmentsClient, using the given settings.protected
RegionCommitmentsClient(RegionCommitmentsStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description RegionCommitmentsClient.AggregatedListPagedResponse
aggregatedList(AggregatedListRegionCommitmentsRequest request)
Retrieves an aggregated list of commitments by region.RegionCommitmentsClient.AggregatedListPagedResponse
aggregatedList(String project)
Retrieves an aggregated list of commitments by region.com.google.api.gax.rpc.UnaryCallable<AggregatedListRegionCommitmentsRequest,CommitmentAggregatedList>
aggregatedListCallable()
Retrieves an aggregated list of commitments by region.com.google.api.gax.rpc.UnaryCallable<AggregatedListRegionCommitmentsRequest,RegionCommitmentsClient.AggregatedListPagedResponse>
aggregatedListPagedCallable()
Retrieves an aggregated list of commitments by region.boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static RegionCommitmentsClient
create()
Constructs an instance of RegionCommitmentsClient with default settings.static RegionCommitmentsClient
create(RegionCommitmentsSettings settings)
Constructs an instance of RegionCommitmentsClient, using the given settings.static RegionCommitmentsClient
create(RegionCommitmentsStub stub)
Constructs an instance of RegionCommitmentsClient, using the given stub for making calls.Commitment
get(GetRegionCommitmentRequest request)
Returns the specified commitment resource.Commitment
get(String project, String region, String commitment)
Returns the specified commitment resource.com.google.api.gax.rpc.UnaryCallable<GetRegionCommitmentRequest,Commitment>
getCallable()
Returns the specified commitment resource.RegionCommitmentsSettings
getSettings()
RegionCommitmentsStub
getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(InsertRegionCommitmentRequest request)
Creates a commitment in the specified project using the data included in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(String project, String region, Commitment commitmentResource)
Creates a commitment in the specified project using the data included in the request.com.google.api.gax.rpc.UnaryCallable<InsertRegionCommitmentRequest,Operation>
insertCallable()
Creates a commitment in the specified project using the data included in the request.com.google.api.gax.rpc.OperationCallable<InsertRegionCommitmentRequest,Operation,Operation>
insertOperationCallable()
Creates a commitment in the specified project using the data included in the request.boolean
isShutdown()
boolean
isTerminated()
RegionCommitmentsClient.ListPagedResponse
list(ListRegionCommitmentsRequest request)
Retrieves a list of commitments contained within the specified region.RegionCommitmentsClient.ListPagedResponse
list(String project, String region)
Retrieves a list of commitments contained within the specified region.com.google.api.gax.rpc.UnaryCallable<ListRegionCommitmentsRequest,CommitmentList>
listCallable()
Retrieves a list of commitments contained within the specified region.com.google.api.gax.rpc.UnaryCallable<ListRegionCommitmentsRequest,RegionCommitmentsClient.ListPagedResponse>
listPagedCallable()
Retrieves a list of commitments contained within the specified region.void
shutdown()
void
shutdownNow()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
updateAsync(UpdateRegionCommitmentRequest request)
Updates the specified commitment with the data included in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
updateAsync(String project, String region, String commitment, Commitment commitmentResource)
Updates the specified commitment with the data included in the request.com.google.api.gax.rpc.UnaryCallable<UpdateRegionCommitmentRequest,Operation>
updateCallable()
Updates the specified commitment with the data included in the request.com.google.api.gax.rpc.OperationCallable<UpdateRegionCommitmentRequest,Operation,Operation>
updateOperationCallable()
Updates the specified commitment with the data included in the request.
-
-
-
Constructor Detail
-
RegionCommitmentsClient
protected RegionCommitmentsClient(RegionCommitmentsSettings settings) throws IOException
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.- Throws:
IOException
-
RegionCommitmentsClient
protected RegionCommitmentsClient(RegionCommitmentsStub stub)
-
-
Method Detail
-
create
public static final RegionCommitmentsClient create() throws IOException
Constructs an instance of RegionCommitmentsClient with default settings.- Throws:
IOException
-
create
public static final RegionCommitmentsClient create(RegionCommitmentsSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final RegionCommitmentsSettings getSettings()
-
getStub
public RegionCommitmentsStub getStub()
-
aggregatedList
public final RegionCommitmentsClient.AggregatedListPagedResponse aggregatedList(String project)
Retrieves an aggregated list of commitments by region.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 (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) { String project = "project-309310695"; for (Map.Entry<String, CommitmentsScopedList> element : regionCommitmentsClient.aggregatedList(project).iterateAll()) { // doThingsWith(element); } }
- Parameters:
project
- Project ID for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
aggregatedList
public final RegionCommitmentsClient.AggregatedListPagedResponse aggregatedList(AggregatedListRegionCommitmentsRequest request)
Retrieves an aggregated list of commitments by region.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 (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<String, CommitmentsScopedList> element : regionCommitmentsClient.aggregatedList(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
aggregatedListPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListRegionCommitmentsRequest,RegionCommitmentsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
Retrieves an aggregated list of commitments by region.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 (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<Map.Entry<String, CommitmentsScopedList>> future = regionCommitmentsClient.aggregatedListPagedCallable().futureCall(request); // Do something. for (Map.Entry<String, CommitmentsScopedList> element : future.get().iterateAll()) { // doThingsWith(element); } }
-
aggregatedListCallable
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListRegionCommitmentsRequest,CommitmentAggregatedList> aggregatedListCallable()
Retrieves an aggregated list of commitments by region.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 (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<String, CommitmentsScopedList> element : response.getItemsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
get
public final Commitment get(String project, String region, String commitment)
Returns the specified commitment 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 (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String commitment = "commitment1019005717"; Commitment response = regionCommitmentsClient.get(project, region, commitment); }
- Parameters:
project
- Project ID for this request.region
- Name of the region for this request.commitment
- Name of the commitment to return.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
get
public final Commitment get(GetRegionCommitmentRequest request)
Returns the specified commitment 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 (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) { GetRegionCommitmentRequest request = GetRegionCommitmentRequest.newBuilder() .setCommitment("commitment1019005717") .setProject("project-309310695") .setRegion("region-934795532") .build(); Commitment response = regionCommitmentsClient.get(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getCallable
public final com.google.api.gax.rpc.UnaryCallable<GetRegionCommitmentRequest,Commitment> getCallable()
Returns the specified commitment 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 (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(); }
-
insertAsync
public final com.google.api.gax.longrunning.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:
// 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 (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:
project
- Project ID for this request.region
- Name of the region for this request.commitmentResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(InsertRegionCommitmentRequest request)
Creates a commitment in the specified project using the data included in the 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 (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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertOperationCallable
public final com.google.api.gax.rpc.OperationCallable<InsertRegionCommitmentRequest,Operation,Operation> insertOperationCallable()
Creates a commitment in the specified project using the data included in the 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 (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) { InsertRegionCommitmentRequest request = InsertRegionCommitmentRequest.newBuilder() .setCommitmentResource(Commitment.newBuilder().build()) .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); OperationFuture<Operation, Operation> future = regionCommitmentsClient.insertOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
insertCallable
public final com.google.api.gax.rpc.UnaryCallable<InsertRegionCommitmentRequest,Operation> insertCallable()
Creates a commitment in the specified project using the data included in the 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 (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(); }
-
list
public final RegionCommitmentsClient.ListPagedResponse list(String project, String region)
Retrieves a list of commitments contained within the specified region.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 (RegionCommitmentsClient regionCommitmentsClient = RegionCommitmentsClient.create()) { String project = "project-309310695"; String region = "region-934795532"; for (Commitment element : regionCommitmentsClient.list(project, region).iterateAll()) { // doThingsWith(element); } }
- Parameters:
project
- Project ID for this request.region
- Name of the region for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
list
public final RegionCommitmentsClient.ListPagedResponse list(ListRegionCommitmentsRequest request)
Retrieves a list of commitments contained within the specified region.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 (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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListRegionCommitmentsRequest,RegionCommitmentsClient.ListPagedResponse> listPagedCallable()
Retrieves a list of commitments contained within the specified region.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 (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); } }
-
listCallable
public final com.google.api.gax.rpc.UnaryCallable<ListRegionCommitmentsRequest,CommitmentList> listCallable()
Retrieves a list of commitments contained within the specified region.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 (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.getItemsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
updateAsync
public final com.google.api.gax.longrunning.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:
// 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 (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:
project
- Project ID for this request.region
- Name of the region for this request.commitment
- Name of the commitment for which auto renew is being updated.commitmentResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.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:
// 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 (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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateOperationCallable
public final com.google.api.gax.rpc.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:
// 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 (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<Operation, Operation> future = regionCommitmentsClient.updateOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
updateCallable
public final com.google.api.gax.rpc.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:
// 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 (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(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-