Class SqlTranslationServiceClient (0.32.0)

Version 0.32.0

• 0.54.0 (latest)
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.2
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.4

public class SqlTranslationServiceClient implements BackgroundResource

Service Description: Provides other SQL dialects to GoogleSQL translation operations.

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 (SqlTranslationServiceClient sqlTranslationServiceClient =
     SqlTranslationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   TranslateQueryRequest.SqlTranslationSourceDialect sourceDialect =
       TranslateQueryRequest.SqlTranslationSourceDialect.forNumber(0);
   String query = "query107944136";
   TranslateQueryResponse response =
       sqlTranslationServiceClient.translateQuery(parent, sourceDialect, query);
 }
 

Note: close() needs to be called on the SqlTranslationServiceClient 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 SqlTranslationServiceSettings 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
 SqlTranslationServiceSettings sqlTranslationServiceSettings =
     SqlTranslationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SqlTranslationServiceClient sqlTranslationServiceClient =
     SqlTranslationServiceClient.create(sqlTranslationServiceSettings);
 

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
 SqlTranslationServiceSettings sqlTranslationServiceSettings =
     SqlTranslationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SqlTranslationServiceClient sqlTranslationServiceClient =
     SqlTranslationServiceClient.create(sqlTranslationServiceSettings);
 

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
 SqlTranslationServiceSettings sqlTranslationServiceSettings =
     SqlTranslationServiceSettings.newHttpJsonBuilder().build();
 SqlTranslationServiceClient sqlTranslationServiceClient =
     SqlTranslationServiceClient.create(sqlTranslationServiceSettings);
 

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

Inheritance

java.lang.Object > SqlTranslationServiceClient

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

Constructs an instance of SqlTranslationServiceClient with default settings.

Returns
Type	Description
SqlTranslationServiceClient

Exceptions
Type	Description
IOException

create(SqlTranslationServiceSettings settings)

public static final SqlTranslationServiceClient create(SqlTranslationServiceSettings settings)

Constructs an instance of SqlTranslationServiceClient, 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	SqlTranslationServiceSettings

Returns
Type	Description
SqlTranslationServiceClient

Exceptions
Type	Description
IOException

create(SqlTranslationServiceStub stub)

public static final SqlTranslationServiceClient create(SqlTranslationServiceStub stub)

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

Parameter
Name	Description
stub	SqlTranslationServiceStub

Returns
Type	Description
SqlTranslationServiceClient

Constructors

SqlTranslationServiceClient(SqlTranslationServiceSettings settings)

protected SqlTranslationServiceClient(SqlTranslationServiceSettings settings)

Constructs an instance of SqlTranslationServiceClient, 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	SqlTranslationServiceSettings

SqlTranslationServiceClient(SqlTranslationServiceStub stub)

protected SqlTranslationServiceClient(SqlTranslationServiceStub stub)

Parameter
Name	Description
stub	SqlTranslationServiceStub

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

getSettings()

public final SqlTranslationServiceSettings getSettings()

Returns
Type	Description
SqlTranslationServiceSettings

getStub()

public SqlTranslationServiceStub getStub()

Returns
Type	Description
SqlTranslationServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

translateQuery(LocationName parent, TranslateQueryRequest.SqlTranslationSourceDialect sourceDialect, String query)

public final TranslateQueryResponse translateQuery(LocationName parent, TranslateQueryRequest.SqlTranslationSourceDialect sourceDialect, String query)

Translates input queries from source dialects to GoogleSQL.

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 (SqlTranslationServiceClient sqlTranslationServiceClient =
     SqlTranslationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   TranslateQueryRequest.SqlTranslationSourceDialect sourceDialect =
       TranslateQueryRequest.SqlTranslationSourceDialect.forNumber(0);
   String query = "query107944136";
   TranslateQueryResponse response =
       sqlTranslationServiceClient.translateQuery(parent, sourceDialect, query);
 }
 

Parameters
Name	Description
parent	LocationName Required. The name of the project to which this translation request belongs. Example: projects/foo/locations/bar
sourceDialect	TranslateQueryRequest.SqlTranslationSourceDialect Required. The source SQL dialect of queries.
query	String Required. The query to be translated.

Returns
Type	Description
TranslateQueryResponse

translateQuery(TranslateQueryRequest request)

public final TranslateQueryResponse translateQuery(TranslateQueryRequest request)

Translates input queries from source dialects to GoogleSQL.

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 (SqlTranslationServiceClient sqlTranslationServiceClient =
     SqlTranslationServiceClient.create()) {
   TranslateQueryRequest request =
       TranslateQueryRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setQuery("query107944136")
           .build();
   TranslateQueryResponse response = sqlTranslationServiceClient.translateQuery(request);
 }
 

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

Returns
Type	Description
TranslateQueryResponse

translateQuery(String parent, TranslateQueryRequest.SqlTranslationSourceDialect sourceDialect, String query)

public final TranslateQueryResponse translateQuery(String parent, TranslateQueryRequest.SqlTranslationSourceDialect sourceDialect, String query)

Translates input queries from source dialects to GoogleSQL.

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 (SqlTranslationServiceClient sqlTranslationServiceClient =
     SqlTranslationServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   TranslateQueryRequest.SqlTranslationSourceDialect sourceDialect =
       TranslateQueryRequest.SqlTranslationSourceDialect.forNumber(0);
   String query = "query107944136";
   TranslateQueryResponse response =
       sqlTranslationServiceClient.translateQuery(parent, sourceDialect, query);
 }
 

Parameters
Name	Description
parent	String Required. The name of the project to which this translation request belongs. Example: projects/foo/locations/bar
sourceDialect	TranslateQueryRequest.SqlTranslationSourceDialect Required. The source SQL dialect of queries.
query	String Required. The query to be translated.

Returns
Type	Description
TranslateQueryResponse

translateQueryCallable()

public final UnaryCallable<TranslateQueryRequest,TranslateQueryResponse> translateQueryCallable()

Translates input queries from source dialects to GoogleSQL.

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 (SqlTranslationServiceClient sqlTranslationServiceClient =
     SqlTranslationServiceClient.create()) {
   TranslateQueryRequest request =
       TranslateQueryRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setQuery("query107944136")
           .build();
   ApiFuture<TranslateQueryResponse> future =
       sqlTranslationServiceClient.translateQueryCallable().futureCall(request);
   // Do something.
   TranslateQueryResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<TranslateQueryRequest,TranslateQueryResponse>