Class SpeechTranslationServiceClient (0.7.10) 

public class SpeechTranslationServiceClient implements BackgroundResource

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:


 try (SpeechTranslationServiceClient speechTranslationServiceClient =
     SpeechTranslationServiceClient.create()) {
   BidiStream

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

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 SpeechTranslationServiceSettings to create(). For example:

To customize credentials:


 SpeechTranslationServiceSettings speechTranslationServiceSettings =
     SpeechTranslationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SpeechTranslationServiceClient speechTranslationServiceClient =
     SpeechTranslationServiceClient.create(speechTranslationServiceSettings);

To customize the endpoint:


 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

Implements

BackgroundResource

Static Methods

create()

public static final SpeechTranslationServiceClient create()

Constructs an instance of SpeechTranslationServiceClient with default settings.

Returns
TypeDescription
SpeechTranslationServiceClient
Exceptions
TypeDescription
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
NameDescription
settingsSpeechTranslationServiceSettings
Returns
TypeDescription
SpeechTranslationServiceClient
Exceptions
TypeDescription
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
NameDescription
stubSpeechTranslationServiceStub
Returns
TypeDescription
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
NameDescription
settingsSpeechTranslationServiceSettings

SpeechTranslationServiceClient(SpeechTranslationServiceStub stub)

protected SpeechTranslationServiceClient(SpeechTranslationServiceStub stub)
Parameter
NameDescription
stubSpeechTranslationServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

getSettings()

public final SpeechTranslationServiceSettings getSettings()
Returns
TypeDescription
SpeechTranslationServiceSettings

getStub()

public SpeechTranslationServiceStub getStub()
Returns
TypeDescription
SpeechTranslationServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
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:


 try (SpeechTranslationServiceClient speechTranslationServiceClient =
     SpeechTranslationServiceClient.create()) {
   BidiStream
Returns
TypeDescription
BidiStreamingCallable<StreamingTranslateSpeechRequest,StreamingTranslateSpeechResponse>