Class AIServiceSpeechClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.aispeech.AIServiceSpeechClient
-
- All Implemented Interfaces:
AIServiceSpeech,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20220101") public class AIServiceSpeechClient extends BaseSyncClient implements AIServiceSpeech
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAIServiceSpeechClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for AIServiceSpeech.
-
Constructor Summary
Constructors Constructor Description AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AIServiceSpeechClient.Builderbuilder()Create a builder for this client.CancelTranscriptionJobResponsecancelTranscriptionJob(CancelTranscriptionJobRequest request)Canceling the job cancels all the tasks under it.CancelTranscriptionTaskResponsecancelTranscriptionTask(CancelTranscriptionTaskRequest request)Cancel Transcription TaskChangeCustomizationCompartmentResponsechangeCustomizationCompartment(ChangeCustomizationCompartmentRequest request)Moves a Customization resource into a different compartment.ChangeTranscriptionJobCompartmentResponsechangeTranscriptionJobCompartment(ChangeTranscriptionJobCompartmentRequest request)Moves a transcription Job resource into a different compartment.voidclose()CreateCustomizationResponsecreateCustomization(CreateCustomizationRequest request)Creates a new Customization.CreateRealtimeSessionTokenResponsecreateRealtimeSessionToken(CreateRealtimeSessionTokenRequest request)Returns an authentication token to the user.CreateTranscriptionJobResponsecreateTranscriptionJob(CreateTranscriptionJobRequest request)Creates a new Transcription Job.DeleteCustomizationResponsedeleteCustomization(DeleteCustomizationRequest request)Delete Customization and its metadata from tenancy.DeleteTranscriptionJobResponsedeleteTranscriptionJob(DeleteTranscriptionJobRequest request)Delete API cleans job, tasks and the related metadata.StringgetClientCommonLibraryVersion()GetCustomizationResponsegetCustomization(GetCustomizationRequest request)Gets a Customization by identifierprotected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Optional<String>getMinimumClientCommonLibraryVersionFromClient()AIServiceSpeechPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetTranscriptionJobResponsegetTranscriptionJob(GetTranscriptionJobRequest request)Gets a Transcription Job by identifierGetTranscriptionTaskResponsegetTranscriptionTask(GetTranscriptionTaskRequest request)Gets a Transcription Task by identifierAIServiceSpeechWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListCustomizationsResponselistCustomizations(ListCustomizationsRequest request)Returns a list of Customizations.ListTranscriptionJobsResponselistTranscriptionJobs(ListTranscriptionJobsRequest request)Returns a list of Transcription Jobs.ListTranscriptionTasksResponselistTranscriptionTasks(ListTranscriptionTasksRequest request)Returns a list of Transcription Tasks.ListVoicesResponselistVoices(ListVoicesRequest request)Returns a list of speakers available to the user to choose from based on language code and voice type provided.voidpopulateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)Populate the parameters in the endpoint with its corresponding value and update the base endpoint.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).SynthesizeSpeechResponsesynthesizeSpeech(SynthesizeSpeechRequest request)Creates an audio for the given input text based on other input parameters like language, voice type, etc.voidupdateBaseEndpoint(String endpoint)This method should be used for parameterized endpoint templates only.UpdateCustomizationResponseupdateCustomization(UpdateCustomizationRequest request)Updates a Customization by identifierUpdateTranscriptionJobResponseupdateTranscriptionJob(UpdateTranscriptionJobRequest request)Updates the Transcription JobvoiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
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.AIServiceSpeech
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Constructor Detail
-
AIServiceSpeechClient
@Deprecated public AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAIServiceSpeechClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
AIServiceSpeechClient
@Deprecated public AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAIServiceSpeechClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
AIServiceSpeechClient
@Deprecated public AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAIServiceSpeechClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
AIServiceSpeechClient
@Deprecated public AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAIServiceSpeechClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
AIServiceSpeechClient
@Deprecated public AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAIServiceSpeechClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
AIServiceSpeechClient
@Deprecated public AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAIServiceSpeechClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
AIServiceSpeechClient
@Deprecated public AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAIServiceSpeechClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
AIServiceSpeechClient
@Deprecated public AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAIServiceSpeechClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-AIServiceSpeechClient.Builder.executorService
-
-
Method Detail
-
builder
public static AIServiceSpeechClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:AIServiceSpeechSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceAIServiceSpeech- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:AIServiceSpeechSets 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 callsetEndpoint.- Specified by:
setRegionin interfaceAIServiceSpeech- Parameters:
regionId- The public region ID.
-
cancelTranscriptionJob
public CancelTranscriptionJobResponse cancelTranscriptionJob(CancelTranscriptionJobRequest request)
Description copied from interface:AIServiceSpeechCanceling the job cancels all the tasks under it.- Specified by:
cancelTranscriptionJobin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cancelTranscriptionTask
public CancelTranscriptionTaskResponse cancelTranscriptionTask(CancelTranscriptionTaskRequest request)
Description copied from interface:AIServiceSpeechCancel Transcription Task- Specified by:
cancelTranscriptionTaskin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeCustomizationCompartment
public ChangeCustomizationCompartmentResponse changeCustomizationCompartment(ChangeCustomizationCompartmentRequest request)
Description copied from interface:AIServiceSpeechMoves a Customization resource into a different compartment.- Specified by:
changeCustomizationCompartmentin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeTranscriptionJobCompartment
public ChangeTranscriptionJobCompartmentResponse changeTranscriptionJobCompartment(ChangeTranscriptionJobCompartmentRequest request)
Description copied from interface:AIServiceSpeechMoves a transcription Job resource into a different compartment.- Specified by:
changeTranscriptionJobCompartmentin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createCustomization
public CreateCustomizationResponse createCustomization(CreateCustomizationRequest request)
Description copied from interface:AIServiceSpeechCreates a new Customization.- Specified by:
createCustomizationin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createRealtimeSessionToken
public CreateRealtimeSessionTokenResponse createRealtimeSessionToken(CreateRealtimeSessionTokenRequest request)
Description copied from interface:AIServiceSpeechReturns an authentication token to the user.- Specified by:
createRealtimeSessionTokenin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTranscriptionJob
public CreateTranscriptionJobResponse createTranscriptionJob(CreateTranscriptionJobRequest request)
Description copied from interface:AIServiceSpeechCreates a new Transcription Job.- Specified by:
createTranscriptionJobin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteCustomization
public DeleteCustomizationResponse deleteCustomization(DeleteCustomizationRequest request)
Description copied from interface:AIServiceSpeechDelete Customization and its metadata from tenancy.- Specified by:
deleteCustomizationin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTranscriptionJob
public DeleteTranscriptionJobResponse deleteTranscriptionJob(DeleteTranscriptionJobRequest request)
Description copied from interface:AIServiceSpeechDelete API cleans job, tasks and the related metadata.However the generated transcriptions in customer tenancy will not be deleted.
- Specified by:
deleteTranscriptionJobin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCustomization
public GetCustomizationResponse getCustomization(GetCustomizationRequest request)
Description copied from interface:AIServiceSpeechGets a Customization by identifier- Specified by:
getCustomizationin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTranscriptionJob
public GetTranscriptionJobResponse getTranscriptionJob(GetTranscriptionJobRequest request)
Description copied from interface:AIServiceSpeechGets a Transcription Job by identifier- Specified by:
getTranscriptionJobin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTranscriptionTask
public GetTranscriptionTaskResponse getTranscriptionTask(GetTranscriptionTaskRequest request)
Description copied from interface:AIServiceSpeechGets a Transcription Task by identifier- Specified by:
getTranscriptionTaskin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCustomizations
public ListCustomizationsResponse listCustomizations(ListCustomizationsRequest request)
Description copied from interface:AIServiceSpeechReturns a list of Customizations.- Specified by:
listCustomizationsin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTranscriptionJobs
public ListTranscriptionJobsResponse listTranscriptionJobs(ListTranscriptionJobsRequest request)
Description copied from interface:AIServiceSpeechReturns a list of Transcription Jobs.- Specified by:
listTranscriptionJobsin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTranscriptionTasks
public ListTranscriptionTasksResponse listTranscriptionTasks(ListTranscriptionTasksRequest request)
Description copied from interface:AIServiceSpeechReturns a list of Transcription Tasks.- Specified by:
listTranscriptionTasksin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listVoices
public ListVoicesResponse listVoices(ListVoicesRequest request)
Description copied from interface:AIServiceSpeechReturns a list of speakers available to the user to choose from based on language code and voice type provided.- Specified by:
listVoicesin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
synthesizeSpeech
public SynthesizeSpeechResponse synthesizeSpeech(SynthesizeSpeechRequest request)
Description copied from interface:AIServiceSpeechCreates an audio for the given input text based on other input parameters like language, voice type, etc.- Specified by:
synthesizeSpeechin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateCustomization
public UpdateCustomizationResponse updateCustomization(UpdateCustomizationRequest request)
Description copied from interface:AIServiceSpeechUpdates a Customization by identifier- Specified by:
updateCustomizationin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTranscriptionJob
public UpdateTranscriptionJobResponse updateTranscriptionJob(UpdateTranscriptionJobRequest request)
Description copied from interface:AIServiceSpeechUpdates the Transcription Job- Specified by:
updateTranscriptionJobin interfaceAIServiceSpeech- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public AIServiceSpeechWaiters getWaiters()
Description copied from interface:AIServiceSpeechGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceAIServiceSpeech- Returns:
- The service waiters.
-
getPaginators
public AIServiceSpeechPaginators getPaginators()
Description copied from interface:AIServiceSpeechGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceAIServiceSpeech- Returns:
- The service paginators.
-
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 userequiredParametersMap- 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 backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-