Class SpeechTranslationServiceClient (0.46.0)

Service Description: Provides translation from/to media types.

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 (SpeechTranslationServiceClient speechTranslationServiceClient =
     SpeechTranslationServiceClient.create()) {
   BidiStream<StreamingTranslateSpeechRequest, StreamingTranslateSpeechResponse> bidiStream =
       speechTranslationServiceClient.streamingTranslateSpeechCallable().call();
   StreamingTranslateSpeechRequest request =
       StreamingTranslateSpeechRequest.newBuilder().build();
   bidiStream.send(request);
   for (StreamingTranslateSpeechResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }

Note: close() needs to be called on the SpeechTranslationServiceClient 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
StreamingTranslateSpeech	Performs bidirectional streaming speech translation: receive results while sending audio. This method is only available via the gRPC API (not REST).	Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. streamingTranslateSpeechCallable()

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 SpeechTranslationServiceSettings 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
 SpeechTranslationServiceSettings speechTranslationServiceSettings =
     SpeechTranslationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SpeechTranslationServiceClient speechTranslationServiceClient =
     SpeechTranslationServiceClient.create(speechTranslationServiceSettings);

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
 SpeechTranslationServiceSettings speechTranslationServiceSettings =
     SpeechTranslationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SpeechTranslationServiceClient speechTranslationServiceClient =
     SpeechTranslationServiceClient.create(speechTranslationServiceSettings);

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

Inheritance

java.lang.Object > SpeechTranslationServiceClient

Static Methods

create()

public static final SpeechTranslationServiceClient create()

Constructs an instance of SpeechTranslationServiceClient with default settings.

Returns
Type	Description
`SpeechTranslationServiceClient`

Exceptions
Type	Description
`IOException`

create(SpeechTranslationServiceSettings settings)

public static final SpeechTranslationServiceClient create(SpeechTranslationServiceSettings settings)

Constructs an instance of SpeechTranslationServiceClient, 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`	`SpeechTranslationServiceSettings`

Returns
Type	Description
`SpeechTranslationServiceClient`

Exceptions
Type	Description
`IOException`

create(SpeechTranslationServiceStub stub)

public static final SpeechTranslationServiceClient create(SpeechTranslationServiceStub stub)

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

Parameter
Name	Description
`stub`	`SpeechTranslationServiceStub`

Returns
Type	Description
`SpeechTranslationServiceClient`

Constructors

SpeechTranslationServiceClient(SpeechTranslationServiceSettings settings)

protected SpeechTranslationServiceClient(SpeechTranslationServiceSettings settings)

Constructs an instance of SpeechTranslationServiceClient, 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`	`SpeechTranslationServiceSettings`

SpeechTranslationServiceClient(SpeechTranslationServiceStub stub)

protected SpeechTranslationServiceClient(SpeechTranslationServiceStub stub)

Parameter
Name	Description
`stub`	`SpeechTranslationServiceStub`

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

Returns
Type	Description
`SpeechTranslationServiceSettings`

getStub()

public SpeechTranslationServiceStub getStub()

Returns
Type	Description
`SpeechTranslationServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

streamingTranslateSpeechCallable()

public final BidiStreamingCallable<StreamingTranslateSpeechRequest,StreamingTranslateSpeechResponse> streamingTranslateSpeechCallable()

Performs bidirectional streaming speech translation: receive results while sending audio. This method is only available via the gRPC API (not REST).

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 (SpeechTranslationServiceClient speechTranslationServiceClient =
     SpeechTranslationServiceClient.create()) {
   BidiStream<StreamingTranslateSpeechRequest, StreamingTranslateSpeechResponse> bidiStream =
       speechTranslationServiceClient.streamingTranslateSpeechCallable().call();
   StreamingTranslateSpeechRequest request =
       StreamingTranslateSpeechRequest.newBuilder().build();
   bidiStream.send(request);
   for (StreamingTranslateSpeechResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }

Returns
Type	Description
`BidiStreamingCallable<StreamingTranslateSpeechRequest,StreamingTranslateSpeechResponse>`