Class SpannerExecutorProxyClient (6.60.0)

public class SpannerExecutorProxyClient implements BackgroundResource

Service Description: Service that executes SpannerActions asynchronously.

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 (SpannerExecutorProxyClient spannerExecutorProxyClient =
     SpannerExecutorProxyClient.create()) {
   BidiStream<SpannerAsyncActionRequest, SpannerAsyncActionResponse> bidiStream =
       spannerExecutorProxyClient.executeActionAsyncCallable().call();
   SpannerAsyncActionRequest request =
       SpannerAsyncActionRequest.newBuilder()
           .setActionId(198295492)
           .setAction(SpannerAction.newBuilder().build())
           .build();
   bidiStream.send(request);
   for (SpannerAsyncActionResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }

Note: close() needs to be called on the SpannerExecutorProxyClient 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
ExecuteActionAsync	ExecuteActionAsync is a streaming call that starts executing a new Spanner action. For each request, the server will reply with one or more responses, but only the last response will contain status in the outcome. Responses can be matched to requests by action_id. It is allowed to have multiple actions in flight--in that case, actions are be executed in parallel.	Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. executeActionAsyncCallable()

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 SpannerExecutorProxySettings 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
 SpannerExecutorProxySettings spannerExecutorProxySettings =
     SpannerExecutorProxySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SpannerExecutorProxyClient spannerExecutorProxyClient =
     SpannerExecutorProxyClient.create(spannerExecutorProxySettings);

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
 SpannerExecutorProxySettings spannerExecutorProxySettings =
     SpannerExecutorProxySettings.newBuilder().setEndpoint(myEndpoint).build();
 SpannerExecutorProxyClient spannerExecutorProxyClient =
     SpannerExecutorProxyClient.create(spannerExecutorProxySettings);

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

Inheritance

java.lang.Object > SpannerExecutorProxyClient

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

Constructs an instance of SpannerExecutorProxyClient with default settings.

Returns
Type	Description
`SpannerExecutorProxyClient`

Exceptions
Type	Description
`IOException`

create(SpannerExecutorProxySettings settings)

public static final SpannerExecutorProxyClient create(SpannerExecutorProxySettings settings)

Constructs an instance of SpannerExecutorProxyClient, 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`	`SpannerExecutorProxySettings`

Returns
Type	Description
`SpannerExecutorProxyClient`

Exceptions
Type	Description
`IOException`

create(SpannerExecutorProxyStub stub)

public static final SpannerExecutorProxyClient create(SpannerExecutorProxyStub stub)

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

Parameter
Name	Description
`stub`	`SpannerExecutorProxyStub`

Returns
Type	Description
`SpannerExecutorProxyClient`

Constructors

SpannerExecutorProxyClient(SpannerExecutorProxySettings settings)

protected SpannerExecutorProxyClient(SpannerExecutorProxySettings settings)

Constructs an instance of SpannerExecutorProxyClient, 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`	`SpannerExecutorProxySettings`

SpannerExecutorProxyClient(SpannerExecutorProxyStub stub)

protected SpannerExecutorProxyClient(SpannerExecutorProxyStub stub)

Parameter
Name	Description
`stub`	`SpannerExecutorProxyStub`

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

executeActionAsyncCallable()

public final BidiStreamingCallable<SpannerAsyncActionRequest,SpannerAsyncActionResponse> executeActionAsyncCallable()

ExecuteActionAsync is a streaming call that starts executing a new Spanner action.

For each request, the server will reply with one or more responses, but only the last response will contain status in the outcome.

Responses can be matched to requests by action_id. It is allowed to have multiple actions in flight--in that case, actions are be executed in parallel.

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 (SpannerExecutorProxyClient spannerExecutorProxyClient =
     SpannerExecutorProxyClient.create()) {
   BidiStream<SpannerAsyncActionRequest, SpannerAsyncActionResponse> bidiStream =
       spannerExecutorProxyClient.executeActionAsyncCallable().call();
   SpannerAsyncActionRequest request =
       SpannerAsyncActionRequest.newBuilder()
           .setActionId(198295492)
           .setAction(SpannerAction.newBuilder().build())
           .build();
   bidiStream.send(request);
   for (SpannerAsyncActionResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }

Returns
Type	Description
`BidiStreamingCallable<SpannerAsyncActionRequest,SpannerAsyncActionResponse>`

getSettings()

public final SpannerExecutorProxySettings getSettings()

Returns
Type	Description
`SpannerExecutorProxySettings`

getStub()

public SpannerExecutorProxyStub getStub()

Returns
Type	Description
`SpannerExecutorProxyStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()