Package com.google.cloud.bigquery.migration.v2alpha

Class SqlTranslationServiceClient

java.lang.Object
com.google.cloud.bigquery.migration.v2alpha.SqlTranslationServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class SqlTranslationServiceClient extends Object 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().

Methods
Method Description Method Variants

TranslateQuery

Translates input queries from source dialects to GoogleSQL.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • translateQuery(TranslateQueryRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

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

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

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • translateQueryCallable()

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.

  • Constructor Details

    • SqlTranslationServiceClient

      protected SqlTranslationServiceClient(SqlTranslationServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • SqlTranslationServiceClient

      protected SqlTranslationServiceClient(SqlTranslationServiceStub stub)

  • Method Details

    • create

      public static final SqlTranslationServiceClient create() throws IOException
      Constructs an instance of SqlTranslationServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final SqlTranslationServiceClient create(SqlTranslationServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • create

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

    • getSettings

      public final SqlTranslationServiceSettings getSettings()

    • getStub

      public SqlTranslationServiceStub getStub()

    • translateQuery

      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:
      parent - Required. The name of the project to which this translation request belongs. Example: `projects/foo/locations/bar`
      sourceDialect - Required. The source SQL dialect of `queries`.
      query - Required. The query to be translated.
      Throws:
      ApiException - if the remote call fails

    • translateQuery

      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:
      parent - Required. The name of the project to which this translation request belongs. Example: `projects/foo/locations/bar`
      sourceDialect - Required. The source SQL dialect of `queries`.
      query - Required. The query to be translated.
      Throws:
      ApiException - if the remote call fails

    • translateQuery

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • 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();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException