|
| 1 | +/** |
| 2 | + * Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. |
| 4 | + */ |
| 5 | +package com.oracle.bmc.aispeech; |
| 6 | + |
| 7 | +import com.oracle.bmc.aispeech.requests.*; |
| 8 | +import com.oracle.bmc.aispeech.responses.*; |
| 9 | + |
| 10 | +/** |
| 11 | + * The OCI Speech Service harnesses the power of spoken language by allowing developers to easily convert file-based data containing human speech into highly accurate text transcriptions. |
| 12 | + * This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user. |
| 13 | + */ |
| 14 | +@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20220101") |
| 15 | +public interface AIServiceSpeech extends AutoCloseable { |
| 16 | + |
| 17 | + /** |
| 18 | + * Sets the endpoint to call (ex, https://www.example.com). |
| 19 | + * @param endpoint The endpoint of the service. |
| 20 | + */ |
| 21 | + void setEndpoint(String endpoint); |
| 22 | + |
| 23 | + /** |
| 24 | + * Gets the set endpoint for REST call (ex, https://www.example.com) |
| 25 | + */ |
| 26 | + String getEndpoint(); |
| 27 | + |
| 28 | + /** |
| 29 | + * Sets the region to call (ex, Region.US_PHOENIX_1). |
| 30 | + * <p> |
| 31 | + * Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised. |
| 32 | + * @param region The region of the service. |
| 33 | + */ |
| 34 | + void setRegion(com.oracle.bmc.Region region); |
| 35 | + |
| 36 | + /** |
| 37 | + * Sets the region to call (ex, 'us-phoenix-1'). |
| 38 | + * <p> |
| 39 | + * Note, this will first try to map the region ID to a known Region and call |
| 40 | + * {@link #setRegion(Region) setRegion}. |
| 41 | + * <p> |
| 42 | + * If no known Region could be determined, it will create an endpoint based on the |
| 43 | + * default endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)} |
| 44 | + * and then call {@link #setEndpoint(String) setEndpoint}. |
| 45 | + * @param regionId The public region ID. |
| 46 | + */ |
| 47 | + void setRegion(String regionId); |
| 48 | + |
| 49 | + /** |
| 50 | + * Canceling the job cancels all the tasks under it. |
| 51 | + * @param request The request object containing the details to send |
| 52 | + * @return A response object containing details about the completed operation |
| 53 | + * @throws BmcException when an error occurs. |
| 54 | + * This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. |
| 55 | + * The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries |
| 56 | + * |
| 57 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/aispeech/CancelTranscriptionJobExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use CancelTranscriptionJob API. |
| 58 | + */ |
| 59 | + CancelTranscriptionJobResponse cancelTranscriptionJob(CancelTranscriptionJobRequest request); |
| 60 | + |
| 61 | + /** |
| 62 | + * Cancel Transcription Task |
| 63 | + * @param request The request object containing the details to send |
| 64 | + * @return A response object containing details about the completed operation |
| 65 | + * @throws BmcException when an error occurs. |
| 66 | + * This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. |
| 67 | + * The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries |
| 68 | + * |
| 69 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/aispeech/CancelTranscriptionTaskExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use CancelTranscriptionTask API. |
| 70 | + */ |
| 71 | + CancelTranscriptionTaskResponse cancelTranscriptionTask(CancelTranscriptionTaskRequest request); |
| 72 | + |
| 73 | + /** |
| 74 | + * Moves a transcription Job resource into a different compartment. |
| 75 | + * @param request The request object containing the details to send |
| 76 | + * @return A response object containing details about the completed operation |
| 77 | + * @throws BmcException when an error occurs. |
| 78 | + * This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. |
| 79 | + * The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries |
| 80 | + * |
| 81 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/aispeech/ChangeTranscriptionJobCompartmentExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use ChangeTranscriptionJobCompartment API. |
| 82 | + */ |
| 83 | + ChangeTranscriptionJobCompartmentResponse changeTranscriptionJobCompartment( |
| 84 | + ChangeTranscriptionJobCompartmentRequest request); |
| 85 | + |
| 86 | + /** |
| 87 | + * Creates a new Transcription Job. |
| 88 | + * |
| 89 | + * @param request The request object containing the details to send |
| 90 | + * @return A response object containing details about the completed operation |
| 91 | + * @throws BmcException when an error occurs. |
| 92 | + * This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. |
| 93 | + * The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries |
| 94 | + * |
| 95 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/aispeech/CreateTranscriptionJobExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use CreateTranscriptionJob API. |
| 96 | + */ |
| 97 | + CreateTranscriptionJobResponse createTranscriptionJob(CreateTranscriptionJobRequest request); |
| 98 | + |
| 99 | + /** |
| 100 | + * Gets a Transcription Job by identifier |
| 101 | + * @param request The request object containing the details to send |
| 102 | + * @return A response object containing details about the completed operation |
| 103 | + * @throws BmcException when an error occurs. |
| 104 | + * This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. |
| 105 | + * The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries |
| 106 | + * |
| 107 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/aispeech/GetTranscriptionJobExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use GetTranscriptionJob API. |
| 108 | + */ |
| 109 | + GetTranscriptionJobResponse getTranscriptionJob(GetTranscriptionJobRequest request); |
| 110 | + |
| 111 | + /** |
| 112 | + * Gets a Transcription Task by identifier |
| 113 | + * @param request The request object containing the details to send |
| 114 | + * @return A response object containing details about the completed operation |
| 115 | + * @throws BmcException when an error occurs. |
| 116 | + * This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. |
| 117 | + * The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries |
| 118 | + * |
| 119 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/aispeech/GetTranscriptionTaskExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use GetTranscriptionTask API. |
| 120 | + */ |
| 121 | + GetTranscriptionTaskResponse getTranscriptionTask(GetTranscriptionTaskRequest request); |
| 122 | + |
| 123 | + /** |
| 124 | + * Returns a list of Transcription Jobs. |
| 125 | + * |
| 126 | + * @param request The request object containing the details to send |
| 127 | + * @return A response object containing details about the completed operation |
| 128 | + * @throws BmcException when an error occurs. |
| 129 | + * This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. |
| 130 | + * The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries |
| 131 | + * |
| 132 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/aispeech/ListTranscriptionJobsExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use ListTranscriptionJobs API. |
| 133 | + */ |
| 134 | + ListTranscriptionJobsResponse listTranscriptionJobs(ListTranscriptionJobsRequest request); |
| 135 | + |
| 136 | + /** |
| 137 | + * Returns a list of Transcription Tasks. |
| 138 | + * |
| 139 | + * @param request The request object containing the details to send |
| 140 | + * @return A response object containing details about the completed operation |
| 141 | + * @throws BmcException when an error occurs. |
| 142 | + * This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. |
| 143 | + * The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries |
| 144 | + * |
| 145 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/aispeech/ListTranscriptionTasksExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use ListTranscriptionTasks API. |
| 146 | + */ |
| 147 | + ListTranscriptionTasksResponse listTranscriptionTasks(ListTranscriptionTasksRequest request); |
| 148 | + |
| 149 | + /** |
| 150 | + * Updates the Transcription Job |
| 151 | + * @param request The request object containing the details to send |
| 152 | + * @return A response object containing details about the completed operation |
| 153 | + * @throws BmcException when an error occurs. |
| 154 | + * This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. |
| 155 | + * The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries |
| 156 | + * |
| 157 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/aispeech/UpdateTranscriptionJobExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use UpdateTranscriptionJob API. |
| 158 | + */ |
| 159 | + UpdateTranscriptionJobResponse updateTranscriptionJob(UpdateTranscriptionJobRequest request); |
| 160 | + |
| 161 | + /** |
| 162 | + * Gets the pre-configured waiters available for resources for this service. |
| 163 | + * |
| 164 | + * @return The service waiters. |
| 165 | + */ |
| 166 | + AIServiceSpeechWaiters getWaiters(); |
| 167 | + |
| 168 | + /** |
| 169 | + * Gets the pre-configured paginators available for list operations in this service which may return multiple |
| 170 | + * pages of data. These paginators provide an {@link java.lang.Iterable} interface so that service responses, or |
| 171 | + * resources/records, can be iterated through without having to manually deal with pagination and page tokens. |
| 172 | + * |
| 173 | + * @return The service paginators. |
| 174 | + */ |
| 175 | + AIServiceSpeechPaginators getPaginators(); |
| 176 | +} |
0 commit comments