Class RegionOperationsClient (1.25.0)

Version 1.25.0

• 1.63.0 (latest)
• 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 RegionOperationsClient implements BackgroundResource

Service Description: The RegionOperations 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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String operation = "operation1662702951";
   DeleteRegionOperationResponse response =
       regionOperationsClient.delete(project, region, operation);
 }
 

Note: close() needs to be called on the RegionOperationsClient 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 RegionOperationsSettings 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
 RegionOperationsSettings regionOperationsSettings =
     RegionOperationsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionOperationsClient regionOperationsClient =
     RegionOperationsClient.create(regionOperationsSettings);
 

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
 RegionOperationsSettings regionOperationsSettings =
     RegionOperationsSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionOperationsClient regionOperationsClient =
     RegionOperationsClient.create(regionOperationsSettings);
 

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

Inheritance

java.lang.Object > RegionOperationsClient

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 RegionOperationsClient create()

Constructs an instance of RegionOperationsClient with default settings.

Returns
Type	Description
RegionOperationsClient

Exceptions
Type	Description
IOException

create(RegionOperationsSettings settings)

public static final RegionOperationsClient create(RegionOperationsSettings settings)

Constructs an instance of RegionOperationsClient, 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	RegionOperationsSettings

Returns
Type	Description
RegionOperationsClient

Exceptions
Type	Description
IOException

create(RegionOperationsStub stub)

public static final RegionOperationsClient create(RegionOperationsStub stub)

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

Parameter
Name	Description
stub	RegionOperationsStub

Returns
Type	Description
RegionOperationsClient

Constructors

RegionOperationsClient(RegionOperationsSettings settings)

protected RegionOperationsClient(RegionOperationsSettings settings)

Constructs an instance of RegionOperationsClient, 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	RegionOperationsSettings

RegionOperationsClient(RegionOperationsStub stub)

protected RegionOperationsClient(RegionOperationsStub stub)

Parameter
Name	Description
stub	RegionOperationsStub

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

delete(DeleteRegionOperationRequest request)

public final DeleteRegionOperationResponse delete(DeleteRegionOperationRequest request)

Deletes the specified region-specific Operations 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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   DeleteRegionOperationRequest request =
       DeleteRegionOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   DeleteRegionOperationResponse response = regionOperationsClient.delete(request);
 }
 

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

Returns
Type	Description
DeleteRegionOperationResponse

delete(String project, String region, String operation)

public final DeleteRegionOperationResponse delete(String project, String region, String operation)

Deletes the specified region-specific Operations 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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String operation = "operation1662702951";
   DeleteRegionOperationResponse response =
       regionOperationsClient.delete(project, region, operation);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
operation	String Name of the Operations resource to delete.

Returns
Type	Description
DeleteRegionOperationResponse

deleteCallable()

public final UnaryCallable<DeleteRegionOperationRequest,DeleteRegionOperationResponse> deleteCallable()

Deletes the specified region-specific Operations 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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   DeleteRegionOperationRequest request =
       DeleteRegionOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<DeleteRegionOperationResponse> future =
       regionOperationsClient.deleteCallable().futureCall(request);
   // Do something.
   DeleteRegionOperationResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteRegionOperationRequest,DeleteRegionOperationResponse>

get(GetRegionOperationRequest request)

public final Operation get(GetRegionOperationRequest request)

Retrieves the specified region-specific Operations 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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   GetRegionOperationRequest request =
       GetRegionOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   Operation response = regionOperationsClient.get(request);
 }
 

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

Returns
Type	Description
Operation

get(String project, String region, String operation)

public final Operation get(String project, String region, String operation)

Retrieves the specified region-specific Operations 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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String operation = "operation1662702951";
   Operation response = regionOperationsClient.get(project, region, operation);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
operation	String Name of the Operations resource to return.

Returns
Type	Description
Operation

getCallable()

public final UnaryCallable<GetRegionOperationRequest,Operation> getCallable()

Retrieves the specified region-specific Operations 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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   GetRegionOperationRequest request =
       GetRegionOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<Operation> future = regionOperationsClient.getCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetRegionOperationRequest,Operation>

getSettings()

public final RegionOperationsSettings getSettings()

Returns
Type	Description
RegionOperationsSettings

getStub()

public RegionOperationsStub getStub()

Returns
Type	Description
RegionOperationsStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

list(ListRegionOperationsRequest request)

public final RegionOperationsClient.ListPagedResponse list(ListRegionOperationsRequest request)

Retrieves a list of Operation resources 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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   ListRegionOperationsRequest request =
       ListRegionOperationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (Operation element : regionOperationsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
RegionOperationsClient.ListPagedResponse

list(String project, String region)

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

Retrieves a list of Operation resources 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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (Operation element : regionOperationsClient.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
RegionOperationsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListRegionOperationsRequest,OperationList> listCallable()

Retrieves a list of Operation resources 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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   ListRegionOperationsRequest request =
       ListRegionOperationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     OperationList response = regionOperationsClient.listCallable().call(request);
     for (Operation 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<ListRegionOperationsRequest,OperationList>

listPagedCallable()

public final UnaryCallable<ListRegionOperationsRequest,RegionOperationsClient.ListPagedResponse> listPagedCallable()

Retrieves a list of Operation resources 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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   ListRegionOperationsRequest request =
       ListRegionOperationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Operation> future = regionOperationsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (Operation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListRegionOperationsRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

wait(WaitRegionOperationRequest request)

public final Operation wait(WaitRegionOperationRequest request)

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.

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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   WaitRegionOperationRequest request =
       WaitRegionOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   Operation response = regionOperationsClient.wait(request);
 }
 

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

Returns
Type	Description
Operation

wait(String project, String region, String operation)

public final Operation wait(String project, String region, String operation)

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.

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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String operation = "operation1662702951";
   Operation response = regionOperationsClient.wait(project, region, operation);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
operation	String Name of the Operations resource to return.

Returns
Type	Description
Operation

waitCallable()

public final UnaryCallable<WaitRegionOperationRequest,Operation> waitCallable()

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.

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 (RegionOperationsClient regionOperationsClient = RegionOperationsClient.create()) {
   WaitRegionOperationRequest request =
       WaitRegionOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<Operation> future = regionOperationsClient.waitCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<WaitRegionOperationRequest,Operation>