com.oracle.bmc.aispeech

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 and Description
static class	AIServiceSpeechClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for AIServiceSpeech.

Constructor Summary

Constructors

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.

Method Summary

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
ChangeTranscriptionJobCompartmentResponse	changeTranscriptionJobCompartment(ChangeTranscriptionJobCompartmentRequest request) Moves a transcription Job resource into a different compartment.
void	close()
CreateTranscriptionJobResponse	createTranscriptionJob(CreateTranscriptionJobRequest request) Creates a new Transcription Job.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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.
ListTranscriptionJobsResponse	listTranscriptionJobs(ListTranscriptionJobsRequest request) Returns a list of Transcription Jobs.
ListTranscriptionTasksResponse	listTranscriptionTasks(ListTranscriptionTasksRequest request) Returns a list of Transcription Tasks.
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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
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.

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

Field Detail

SERVICE

public static final Service SERVICE

Service instance for AIServiceSpeech.

Constructor Detail

AIServiceSpeechClient

@Deprecated
public AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

AIServiceSpeechClient

@Deprecated
public AIServiceSpeechClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

AIServiceSpeechClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

AIServiceSpeechClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

AIServiceSpeechClient

@Deprecated
public AIServiceSpeechClient(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 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

AIServiceSpeechClient

@Deprecated
public AIServiceSpeechClient(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 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)

AIServiceSpeechClient

@Deprecated
public AIServiceSpeechClient(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 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

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 the builder instead.

Create a new client instance.

Parameters:

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

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: 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.

Specified by:

setRegion in interface AIServiceSpeech

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: 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.

Specified by:

setRegion in interface AIServiceSpeech

Parameters:

regionId - The public region ID.

cancelTranscriptionJob

public CancelTranscriptionJobResponse cancelTranscriptionJob(CancelTranscriptionJobRequest request)

Description copied from interface: AIServiceSpeech

Canceling the job cancels all the tasks under it.

Specified by:

cancelTranscriptionJob in interface AIServiceSpeech

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: AIServiceSpeech

Cancel Transcription Task

Specified by:

cancelTranscriptionTask in interface AIServiceSpeech

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: AIServiceSpeech

Moves a transcription Job resource into a different compartment.

Specified by:

changeTranscriptionJobCompartment in interface AIServiceSpeech

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: AIServiceSpeech

Creates a new Transcription Job.

Specified by:

createTranscriptionJob in interface AIServiceSpeech

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: AIServiceSpeech

Gets a Transcription Job by identifier

Specified by:

getTranscriptionJob in interface AIServiceSpeech

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: AIServiceSpeech

Gets a Transcription Task by identifier

Specified by:

getTranscriptionTask in interface AIServiceSpeech

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: AIServiceSpeech

Returns a list of Transcription Jobs.

Specified by:

listTranscriptionJobs in interface AIServiceSpeech

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: AIServiceSpeech

Returns a list of Transcription Tasks.

Specified by:

listTranscriptionTasks in interface AIServiceSpeech

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: AIServiceSpeech

Updates the Transcription Job

Specified by:

updateTranscriptionJob in interface AIServiceSpeech

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: AIServiceSpeech

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface AIServiceSpeech

Returns:

The service waiters.

getPaginators

public AIServiceSpeechPaginators getPaginators()

Description copied from interface: 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.

Specified by:

getPaginators in interface AIServiceSpeech

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 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