Class AdapterClient (0.4.0)

Service Description: Cloud Spanner Adapter API

The Cloud Spanner Adapter service allows native drivers of supported database dialects to interact directly with Cloud Spanner by wrapping the underlying wire protocol used by the driver in a gRPC stream.

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 (AdapterClient adapterClient = AdapterClient.create()) {
   DatabaseName parent = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
   Session session = Session.newBuilder().build();
   Session response = adapterClient.createSession(parent, session);
 }

Note: close() needs to be called on the AdapterClient 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
CreateSession	Creates a new session to be used for requests made by the adapter. A session identifies a specific incarnation of a database resource and is meant to be reused across many `AdaptMessage` calls.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createSession(CreateSessionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createSession(DatabaseName parent, Session session) createSession(String parent, Session session) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createSessionCallable()
AdaptMessage	Handles a single message from the client and returns the result as a stream. The server will interpret the message frame and respond with message frames to the client.	Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. adaptMessageCallable()

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 AdapterSettings 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
 AdapterSettings adapterSettings =
     AdapterSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AdapterClient adapterClient = AdapterClient.create(adapterSettings);

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
 AdapterSettings adapterSettings = AdapterSettings.newBuilder().setEndpoint(myEndpoint).build();
 AdapterClient adapterClient = AdapterClient.create(adapterSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 AdapterSettings adapterSettings = AdapterSettings.newHttpJsonBuilder().build();
 AdapterClient adapterClient = AdapterClient.create(adapterSettings);

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

Inheritance

java.lang.Object > AdapterClient

Static Methods

create()

public static final AdapterClient create()

Constructs an instance of AdapterClient with default settings.

Returns
Type	Description
`AdapterClient`

Exceptions
Type	Description
`IOException`

create(AdapterSettings settings)

public static final AdapterClient create(AdapterSettings settings)

Constructs an instance of AdapterClient, 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`	`AdapterSettings`

Returns
Type	Description
`AdapterClient`

Exceptions
Type	Description
`IOException`

create(AdapterStub stub)

public static final AdapterClient create(AdapterStub stub)

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

Parameter
Name	Description
`stub`	`AdapterStub`

Returns
Type	Description
`AdapterClient`

Constructors

AdapterClient(AdapterSettings settings)

protected AdapterClient(AdapterSettings settings)

Constructs an instance of AdapterClient, 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`	`AdapterSettings`

AdapterClient(AdapterStub stub)

protected AdapterClient(AdapterStub stub)

Parameter
Name	Description
`stub`	`AdapterStub`

Methods

adaptMessageCallable()

public final ServerStreamingCallable<AdaptMessageRequest,AdaptMessageResponse> adaptMessageCallable()

Handles a single message from the client and returns the result as a stream. The server will interpret the message frame and respond with message frames to the client.

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 (AdapterClient adapterClient = AdapterClient.create()) {
   AdaptMessageRequest request =
       AdaptMessageRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setProtocol("protocol-989163880")
           .setPayload(ByteString.EMPTY)
           .putAllAttachments(new HashMap<String, String>())
           .build();
   ServerStream<AdaptMessageResponse> stream =
       adapterClient.adaptMessageCallable().call(request);
   for (AdaptMessageResponse response : stream) {
     // Do something when a response is received.
   }
 }

Returns
Type	Description
`ServerStreamingCallable<AdaptMessageRequest,AdaptMessageResponse>`

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

createSession(CreateSessionRequest request)

public final Session createSession(CreateSessionRequest request)

Creates a new session to be used for requests made by the adapter. A session identifies a specific incarnation of a database resource and is meant to be reused across many AdaptMessage calls.

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 (AdapterClient adapterClient = AdapterClient.create()) {
   CreateSessionRequest request =
       CreateSessionRequest.newBuilder()
           .setParent(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
           .setSession(Session.newBuilder().build())
           .build();
   Session response = adapterClient.createSession(request);
 }

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

Returns
Type	Description
`Session`

createSession(DatabaseName parent, Session session)

public final Session createSession(DatabaseName parent, Session session)

Creates a new session to be used for requests made by the adapter. A session identifies a specific incarnation of a database resource and is meant to be reused across many AdaptMessage calls.

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 (AdapterClient adapterClient = AdapterClient.create()) {
   DatabaseName parent = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
   Session session = Session.newBuilder().build();
   Session response = adapterClient.createSession(parent, session);
 }

Parameters
Name	Description
`parent`	`DatabaseName` Required. The database in which the new session is created.
`session`	`Session` Required. The session to create.

Returns
Type	Description
`Session`

createSession(String parent, Session session)

public final Session createSession(String parent, Session session)

Creates a new session to be used for requests made by the adapter. A session identifies a specific incarnation of a database resource and is meant to be reused across many AdaptMessage calls.

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 (AdapterClient adapterClient = AdapterClient.create()) {
   String parent = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
   Session session = Session.newBuilder().build();
   Session response = adapterClient.createSession(parent, session);
 }

Parameters
Name	Description
`parent`	`String` Required. The database in which the new session is created.
`session`	`Session` Required. The session to create.

Returns
Type	Description
`Session`

createSessionCallable()

public final UnaryCallable<CreateSessionRequest,Session> createSessionCallable()

Creates a new session to be used for requests made by the adapter. A session identifies a specific incarnation of a database resource and is meant to be reused across many AdaptMessage calls.

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 (AdapterClient adapterClient = AdapterClient.create()) {
   CreateSessionRequest request =
       CreateSessionRequest.newBuilder()
           .setParent(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
           .setSession(Session.newBuilder().build())
           .build();
   ApiFuture<Session> future = adapterClient.createSessionCallable().futureCall(request);
   // Do something.
   Session response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateSessionRequest,Session>`

getSettings()

public final AdapterSettings getSettings()

Returns
Type	Description
`AdapterSettings`

getStub()

public AdapterStub getStub()

Returns
Type	Description
`AdapterStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

Class AdapterClient (0.4.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(AdapterSettings settings)

create(AdapterStub stub)

Constructors

AdapterClient(AdapterSettings settings)

AdapterClient(AdapterStub stub)

Methods

adaptMessageCallable()

awaitTermination(long duration, TimeUnit unit)

close()

createSession(CreateSessionRequest request)

createSession(DatabaseName parent, Session session)

createSession(String parent, Session session)

createSessionCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

shutdown()

shutdownNow()

Class AdapterClient (0.4.0)