com.oracle.bmc.aispeech

Class AIServiceSpeechAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.aispeech.AIServiceSpeechAsyncClient

All Implemented Interfaces:

AIServiceSpeechAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220101")
public class AIServiceSpeechAsyncClient
extends BaseAsyncClient
implements AIServiceSpeechAsync

Async client implementation for AIServiceSpeech service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AIServiceSpeechAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for AIServiceSpeech.

Constructor Summary

Constructors

Constructor and Description
AIServiceSpeechAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
AIServiceSpeechAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
AIServiceSpeechAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
AIServiceSpeechAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
AIServiceSpeechAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
AIServiceSpeechAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
AIServiceSpeechAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static AIServiceSpeechAsyncClient.Builder	builder() Create a builder for this client.
Future<CancelTranscriptionJobResponse>	cancelTranscriptionJob(CancelTranscriptionJobRequest request, AsyncHandler<CancelTranscriptionJobRequest,CancelTranscriptionJobResponse> handler) Canceling the job cancels all the tasks under it.
Future<CancelTranscriptionTaskResponse>	cancelTranscriptionTask(CancelTranscriptionTaskRequest request, AsyncHandler<CancelTranscriptionTaskRequest,CancelTranscriptionTaskResponse> handler) Cancel Transcription Task
Future<ChangeCustomizationCompartmentResponse>	changeCustomizationCompartment(ChangeCustomizationCompartmentRequest request, AsyncHandler<ChangeCustomizationCompartmentRequest,ChangeCustomizationCompartmentResponse> handler) Moves a Customization resource into a different compartment.
Future<ChangeTranscriptionJobCompartmentResponse>	changeTranscriptionJobCompartment(ChangeTranscriptionJobCompartmentRequest request, AsyncHandler<ChangeTranscriptionJobCompartmentRequest,ChangeTranscriptionJobCompartmentResponse> handler) Moves a transcription Job resource into a different compartment.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateCustomizationResponse>	createCustomization(CreateCustomizationRequest request, AsyncHandler<CreateCustomizationRequest,CreateCustomizationResponse> handler) Creates a new Customization.
Future<CreateRealtimeSessionTokenResponse>	createRealtimeSessionToken(CreateRealtimeSessionTokenRequest request, AsyncHandler<CreateRealtimeSessionTokenRequest,CreateRealtimeSessionTokenResponse> handler) Returns an authentication token to the user.
Future<CreateTranscriptionJobResponse>	createTranscriptionJob(CreateTranscriptionJobRequest request, AsyncHandler<CreateTranscriptionJobRequest,CreateTranscriptionJobResponse> handler) Creates a new Transcription Job.
Future<DeleteCustomizationResponse>	deleteCustomization(DeleteCustomizationRequest request, AsyncHandler<DeleteCustomizationRequest,DeleteCustomizationResponse> handler) Delete Customization and its metadata from tenancy.
Future<DeleteTranscriptionJobResponse>	deleteTranscriptionJob(DeleteTranscriptionJobRequest request, AsyncHandler<DeleteTranscriptionJobRequest,DeleteTranscriptionJobResponse> handler) Delete API cleans job, tasks and the related metadata.
String	getClientCommonLibraryVersion()
Future<GetCustomizationResponse>	getCustomization(GetCustomizationRequest request, AsyncHandler<GetCustomizationRequest,GetCustomizationResponse> handler) Gets a Customization by identifier
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetTranscriptionJobResponse>	getTranscriptionJob(GetTranscriptionJobRequest request, AsyncHandler<GetTranscriptionJobRequest,GetTranscriptionJobResponse> handler) Gets a Transcription Job by identifier
Future<GetTranscriptionTaskResponse>	getTranscriptionTask(GetTranscriptionTaskRequest request, AsyncHandler<GetTranscriptionTaskRequest,GetTranscriptionTaskResponse> handler) Gets a Transcription Task by identifier
Future<ListCustomizationsResponse>	listCustomizations(ListCustomizationsRequest request, AsyncHandler<ListCustomizationsRequest,ListCustomizationsResponse> handler) Returns a list of Customizations.
Future<ListTranscriptionJobsResponse>	listTranscriptionJobs(ListTranscriptionJobsRequest request, AsyncHandler<ListTranscriptionJobsRequest,ListTranscriptionJobsResponse> handler) Returns a list of Transcription Jobs.
Future<ListTranscriptionTasksResponse>	listTranscriptionTasks(ListTranscriptionTasksRequest request, AsyncHandler<ListTranscriptionTasksRequest,ListTranscriptionTasksResponse> handler) Returns a list of Transcription Tasks.
Future<ListVoicesResponse>	listVoices(ListVoicesRequest request, AsyncHandler<ListVoicesRequest,ListVoicesResponse> handler) Returns a list of speakers available to the user to choose from based on language code and voice type provided.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<SynthesizeSpeechResponse>	synthesizeSpeech(SynthesizeSpeechRequest request, AsyncHandler<SynthesizeSpeechRequest,SynthesizeSpeechResponse> handler) Creates an audio for the given input text based on other input parameters like language, voice type, etc.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateCustomizationResponse>	updateCustomization(UpdateCustomizationRequest request, AsyncHandler<UpdateCustomizationRequest,UpdateCustomizationResponse> handler) Updates a Customization by identifier
Future<UpdateTranscriptionJobResponse>	updateTranscriptionJob(UpdateTranscriptionJobRequest request, AsyncHandler<UpdateTranscriptionJobRequest,UpdateTranscriptionJobResponse> handler) Updates the Transcription Job
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.aispeech.AIServiceSpeechAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for AIServiceSpeech.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

AIServiceSpeechAsyncClient

@Deprecated
public AIServiceSpeechAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AIServiceSpeechAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

AIServiceSpeechAsyncClient

@Deprecated
public AIServiceSpeechAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AIServiceSpeechAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

AIServiceSpeechAsyncClient

@Deprecated
public AIServiceSpeechAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AIServiceSpeechAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

AIServiceSpeechAsyncClient

@Deprecated
public AIServiceSpeechAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator,
                                              RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AIServiceSpeechAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

AIServiceSpeechAsyncClient

@Deprecated
public AIServiceSpeechAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator,
                                              RequestSignerFactory defaultRequestSignerFactory,
                                              List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AIServiceSpeechAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

AIServiceSpeechAsyncClient

@Deprecated
public AIServiceSpeechAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator,
                                              RequestSignerFactory defaultRequestSignerFactory,
                                              List<ClientConfigurator> additionalClientConfigurators,
                                              String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AIServiceSpeechAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

AIServiceSpeechAsyncClient

@Deprecated
public AIServiceSpeechAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator,
                                              RequestSignerFactory defaultRequestSignerFactory,
                                              Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                              List<ClientConfigurator> additionalClientConfigurators,
                                              String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AIServiceSpeechAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static AIServiceSpeechAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: AIServiceSpeechAsync

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface AIServiceSpeechAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: AIServiceSpeechAsync

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface AIServiceSpeechAsync

Parameters:

regionId - The public region ID.

cancelTranscriptionJob

public Future<CancelTranscriptionJobResponse> cancelTranscriptionJob(CancelTranscriptionJobRequest request,
                                                                     AsyncHandler<CancelTranscriptionJobRequest,CancelTranscriptionJobResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Canceling the job cancels all the tasks under it.

Specified by:

cancelTranscriptionJob in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

cancelTranscriptionTask

public Future<CancelTranscriptionTaskResponse> cancelTranscriptionTask(CancelTranscriptionTaskRequest request,
                                                                       AsyncHandler<CancelTranscriptionTaskRequest,CancelTranscriptionTaskResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Cancel Transcription Task

Specified by:

cancelTranscriptionTask in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeCustomizationCompartment

public Future<ChangeCustomizationCompartmentResponse> changeCustomizationCompartment(ChangeCustomizationCompartmentRequest request,
                                                                                     AsyncHandler<ChangeCustomizationCompartmentRequest,ChangeCustomizationCompartmentResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Moves a Customization resource into a different compartment.

Specified by:

changeCustomizationCompartment in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeTranscriptionJobCompartment

public Future<ChangeTranscriptionJobCompartmentResponse> changeTranscriptionJobCompartment(ChangeTranscriptionJobCompartmentRequest request,
                                                                                           AsyncHandler<ChangeTranscriptionJobCompartmentRequest,ChangeTranscriptionJobCompartmentResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Moves a transcription Job resource into a different compartment.

Specified by:

changeTranscriptionJobCompartment in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createCustomization

public Future<CreateCustomizationResponse> createCustomization(CreateCustomizationRequest request,
                                                               AsyncHandler<CreateCustomizationRequest,CreateCustomizationResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Creates a new Customization.

Specified by:

createCustomization in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createRealtimeSessionToken

public Future<CreateRealtimeSessionTokenResponse> createRealtimeSessionToken(CreateRealtimeSessionTokenRequest request,
                                                                             AsyncHandler<CreateRealtimeSessionTokenRequest,CreateRealtimeSessionTokenResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Returns an authentication token to the user.

Specified by:

createRealtimeSessionToken in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createTranscriptionJob

public Future<CreateTranscriptionJobResponse> createTranscriptionJob(CreateTranscriptionJobRequest request,
                                                                     AsyncHandler<CreateTranscriptionJobRequest,CreateTranscriptionJobResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Creates a new Transcription Job.

Specified by:

createTranscriptionJob in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteCustomization

public Future<DeleteCustomizationResponse> deleteCustomization(DeleteCustomizationRequest request,
                                                               AsyncHandler<DeleteCustomizationRequest,DeleteCustomizationResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Delete Customization and its metadata from tenancy.

Specified by:

deleteCustomization in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteTranscriptionJob

public Future<DeleteTranscriptionJobResponse> deleteTranscriptionJob(DeleteTranscriptionJobRequest request,
                                                                     AsyncHandler<DeleteTranscriptionJobRequest,DeleteTranscriptionJobResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Delete API cleans job, tasks and the related metadata. However the generated transcriptions in customer tenancy will not be deleted.

Specified by:

deleteTranscriptionJob in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getCustomization

public Future<GetCustomizationResponse> getCustomization(GetCustomizationRequest request,
                                                         AsyncHandler<GetCustomizationRequest,GetCustomizationResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Gets a Customization by identifier

Specified by:

getCustomization in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getTranscriptionJob

public Future<GetTranscriptionJobResponse> getTranscriptionJob(GetTranscriptionJobRequest request,
                                                               AsyncHandler<GetTranscriptionJobRequest,GetTranscriptionJobResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Gets a Transcription Job by identifier

Specified by:

getTranscriptionJob in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getTranscriptionTask

public Future<GetTranscriptionTaskResponse> getTranscriptionTask(GetTranscriptionTaskRequest request,
                                                                 AsyncHandler<GetTranscriptionTaskRequest,GetTranscriptionTaskResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Gets a Transcription Task by identifier

Specified by:

getTranscriptionTask in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listCustomizations

public Future<ListCustomizationsResponse> listCustomizations(ListCustomizationsRequest request,
                                                             AsyncHandler<ListCustomizationsRequest,ListCustomizationsResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Returns a list of Customizations.

Specified by:

listCustomizations in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listTranscriptionJobs

public Future<ListTranscriptionJobsResponse> listTranscriptionJobs(ListTranscriptionJobsRequest request,
                                                                   AsyncHandler<ListTranscriptionJobsRequest,ListTranscriptionJobsResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Returns a list of Transcription Jobs.

Specified by:

listTranscriptionJobs in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listTranscriptionTasks

public Future<ListTranscriptionTasksResponse> listTranscriptionTasks(ListTranscriptionTasksRequest request,
                                                                     AsyncHandler<ListTranscriptionTasksRequest,ListTranscriptionTasksResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Returns a list of Transcription Tasks.

Specified by:

listTranscriptionTasks in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listVoices

public Future<ListVoicesResponse> listVoices(ListVoicesRequest request,
                                             AsyncHandler<ListVoicesRequest,ListVoicesResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Returns a list of speakers available to the user to choose from based on language code and voice type provided.

Specified by:

listVoices in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

synthesizeSpeech

public Future<SynthesizeSpeechResponse> synthesizeSpeech(SynthesizeSpeechRequest request,
                                                         AsyncHandler<SynthesizeSpeechRequest,SynthesizeSpeechResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Creates an audio for the given input text based on other input parameters like language, voice type, etc.

Specified by:

synthesizeSpeech in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateCustomization

public Future<UpdateCustomizationResponse> updateCustomization(UpdateCustomizationRequest request,
                                                               AsyncHandler<UpdateCustomizationRequest,UpdateCustomizationResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Updates a Customization by identifier

Specified by:

updateCustomization in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateTranscriptionJob

public Future<UpdateTranscriptionJobResponse> updateTranscriptionJob(UpdateTranscriptionJobRequest request,
                                                                     AsyncHandler<UpdateTranscriptionJobRequest,UpdateTranscriptionJobResponse> handler)

Description copied from interface: AIServiceSpeechAsync

Updates the Transcription Job

Specified by:

updateTranscriptionJob in interface AIServiceSpeechAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)