@Generated(value="OracleSDKGenerator", comments="API Version: 20220101") public class AIServiceSpeechClient extends BaseSyncClient implements AIServiceSpeech
Modifier and Type | Class and Description |
---|---|
static class |
AIServiceSpeechClient.Builder
Builder class for this client.
|
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 and Description |
---|
AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
Modifier and Type | Method and Description |
---|---|
static AIServiceSpeechClient.Builder |
builder()
Create a builder for this client.
|
CancelTranscriptionJobResponse |
cancelTranscriptionJob(CancelTranscriptionJobRequest request)
Canceling the job cancels all the tasks under it.
|
CancelTranscriptionTaskResponse |
cancelTranscriptionTask(CancelTranscriptionTaskRequest request)
Cancel Transcription Task
|
ChangeCustomizationCompartmentResponse |
changeCustomizationCompartment(ChangeCustomizationCompartmentRequest request)
Moves a Customization resource into a different compartment.
|
ChangeTranscriptionJobCompartmentResponse |
changeTranscriptionJobCompartment(ChangeTranscriptionJobCompartmentRequest request)
Moves a transcription Job resource into a different compartment.
|
void |
close() |
CreateCustomizationResponse |
createCustomization(CreateCustomizationRequest request)
Creates a new Customization.
|
CreateRealtimeSessionTokenResponse |
createRealtimeSessionToken(CreateRealtimeSessionTokenRequest request)
Returns an authentication token to the user.
|
CreateTranscriptionJobResponse |
createTranscriptionJob(CreateTranscriptionJobRequest request)
Creates a new Transcription Job.
|
DeleteCustomizationResponse |
deleteCustomization(DeleteCustomizationRequest request)
Delete Customization and its metadata from tenancy.
|
DeleteTranscriptionJobResponse |
deleteTranscriptionJob(DeleteTranscriptionJobRequest request)
Delete API cleans job, tasks and the related metadata.
|
String |
getClientCommonLibraryVersion() |
GetCustomizationResponse |
getCustomization(GetCustomizationRequest request)
Gets a Customization by identifier
|
protected ClientConfigurator |
getDefaultConfigurator() |
String |
getEndpoint() |
Optional<String> |
getMinimumClientCommonLibraryVersionFromClient() |
AIServiceSpeechPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data.
|
GetTranscriptionJobResponse |
getTranscriptionJob(GetTranscriptionJobRequest request)
Gets a Transcription Job by identifier
|
GetTranscriptionTaskResponse |
getTranscriptionTask(GetTranscriptionTaskRequest request)
Gets a Transcription Task by identifier
|
AIServiceSpeechWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListCustomizationsResponse |
listCustomizations(ListCustomizationsRequest request)
Returns a list of Customizations.
|
ListTranscriptionJobsResponse |
listTranscriptionJobs(ListTranscriptionJobsRequest request)
Returns a list of Transcription Jobs.
|
ListTranscriptionTasksResponse |
listTranscriptionTasks(ListTranscriptionTasksRequest request)
Returns a list of Transcription Tasks.
|
ListVoicesResponse |
listVoices(ListVoicesRequest request)
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’).
|
SynthesizeSpeechResponse |
synthesizeSpeech(SynthesizeSpeechRequest request)
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.
|
UpdateCustomizationResponse |
updateCustomization(UpdateCustomizationRequest request)
Updates a Customization by identifier
|
UpdateTranscriptionJobResponse |
updateTranscriptionJob(UpdateTranscriptionJobRequest request)
Updates the Transcription Job
|
void |
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.
|
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for AIServiceSpeech.
public final String clientCommonLibraryVersion
@Deprecated public AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see AIServiceSpeechClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see AIServiceSpeechClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see AIServiceSpeechClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see AIServiceSpeechClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see AIServiceSpeechClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see AIServiceSpeechClient.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)
@Deprecated public AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see AIServiceSpeechClient.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
@Deprecated public AIServiceSpeechClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see AIServiceSpeechClient.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
executorService
- AIServiceSpeechClient.Builder.executorService
public static AIServiceSpeechClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
AIServiceSpeech
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.
setRegion
in interface AIServiceSpeech
region
- The region of the service.public void setRegion(String regionId)
AIServiceSpeech
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
.
setRegion
in interface AIServiceSpeech
regionId
- The public region ID.public CancelTranscriptionJobResponse cancelTranscriptionJob(CancelTranscriptionJobRequest request)
AIServiceSpeech
Canceling the job cancels all the tasks under it.
cancelTranscriptionJob
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic CancelTranscriptionTaskResponse cancelTranscriptionTask(CancelTranscriptionTaskRequest request)
AIServiceSpeech
Cancel Transcription Task
cancelTranscriptionTask
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic ChangeCustomizationCompartmentResponse changeCustomizationCompartment(ChangeCustomizationCompartmentRequest request)
AIServiceSpeech
Moves a Customization resource into a different compartment.
changeCustomizationCompartment
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic ChangeTranscriptionJobCompartmentResponse changeTranscriptionJobCompartment(ChangeTranscriptionJobCompartmentRequest request)
AIServiceSpeech
Moves a transcription Job resource into a different compartment.
changeTranscriptionJobCompartment
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic CreateCustomizationResponse createCustomization(CreateCustomizationRequest request)
AIServiceSpeech
Creates a new Customization.
createCustomization
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic CreateRealtimeSessionTokenResponse createRealtimeSessionToken(CreateRealtimeSessionTokenRequest request)
AIServiceSpeech
Returns an authentication token to the user.
createRealtimeSessionToken
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic CreateTranscriptionJobResponse createTranscriptionJob(CreateTranscriptionJobRequest request)
AIServiceSpeech
Creates a new Transcription Job.
createTranscriptionJob
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic DeleteCustomizationResponse deleteCustomization(DeleteCustomizationRequest request)
AIServiceSpeech
Delete Customization and its metadata from tenancy.
deleteCustomization
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic DeleteTranscriptionJobResponse deleteTranscriptionJob(DeleteTranscriptionJobRequest request)
AIServiceSpeech
Delete API cleans job, tasks and the related metadata. However the generated transcriptions in customer tenancy will not be deleted.
deleteTranscriptionJob
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic GetCustomizationResponse getCustomization(GetCustomizationRequest request)
AIServiceSpeech
Gets a Customization by identifier
getCustomization
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic GetTranscriptionJobResponse getTranscriptionJob(GetTranscriptionJobRequest request)
AIServiceSpeech
Gets a Transcription Job by identifier
getTranscriptionJob
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic GetTranscriptionTaskResponse getTranscriptionTask(GetTranscriptionTaskRequest request)
AIServiceSpeech
Gets a Transcription Task by identifier
getTranscriptionTask
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic ListCustomizationsResponse listCustomizations(ListCustomizationsRequest request)
AIServiceSpeech
Returns a list of Customizations.
listCustomizations
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic ListTranscriptionJobsResponse listTranscriptionJobs(ListTranscriptionJobsRequest request)
AIServiceSpeech
Returns a list of Transcription Jobs.
listTranscriptionJobs
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic ListTranscriptionTasksResponse listTranscriptionTasks(ListTranscriptionTasksRequest request)
AIServiceSpeech
Returns a list of Transcription Tasks.
listTranscriptionTasks
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic ListVoicesResponse listVoices(ListVoicesRequest request)
AIServiceSpeech
Returns a list of speakers available to the user to choose from based on language code and voice type provided.
listVoices
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic SynthesizeSpeechResponse synthesizeSpeech(SynthesizeSpeechRequest request)
AIServiceSpeech
Creates an audio for the given input text based on other input parameters like language, voice type, etc.
synthesizeSpeech
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic UpdateCustomizationResponse updateCustomization(UpdateCustomizationRequest request)
AIServiceSpeech
Updates a Customization by identifier
updateCustomization
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic UpdateTranscriptionJobResponse updateTranscriptionJob(UpdateTranscriptionJobRequest request)
AIServiceSpeech
Updates the Transcription Job
updateTranscriptionJob
in interface AIServiceSpeech
request
- The request object containing the details to sendpublic AIServiceSpeechWaiters getWaiters()
AIServiceSpeech
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface AIServiceSpeech
public AIServiceSpeechPaginators getPaginators()
AIServiceSpeech
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without
having to manually deal with pagination and page tokens.
getPaginators
in interface AIServiceSpeech
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
Copyright © 2016–2024. All rights reserved.