com.google.cloud.translate.v3.TranslationServiceSettings Maven / Gradle / Ivy
Show all versions of google-cloud-translate Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.translate.v3;
import static com.google.cloud.translate.v3.TranslationServiceClient.ListAdaptiveMtDatasetsPagedResponse;
import static com.google.cloud.translate.v3.TranslationServiceClient.ListAdaptiveMtFilesPagedResponse;
import static com.google.cloud.translate.v3.TranslationServiceClient.ListAdaptiveMtSentencesPagedResponse;
import static com.google.cloud.translate.v3.TranslationServiceClient.ListGlossariesPagedResponse;
import com.google.api.core.ApiFunction;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.ClientSettings;
import com.google.api.gax.rpc.OperationCallSettings;
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.cloud.translate.v3.stub.TranslationServiceStubSettings;
import com.google.longrunning.Operation;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Settings class to configure an instance of {@link TranslationServiceClient}.
*
* The default instance has everything set to sensible defaults:
*
*
* - The default service address (translate.googleapis.com) and default port (443) are used.
*
- Credentials are acquired automatically through Application Default Credentials.
*
- Retries are configured for idempotent methods but not for non-idempotent methods.
*
*
* The builder of this class is recursive, so contained classes are themselves builders. When
* build() is called, the tree of builders is called to create the complete settings object.
*
*
For example, to set the total timeout of translateText to 30 seconds:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* TranslationServiceSettings.Builder translationServiceSettingsBuilder =
* TranslationServiceSettings.newBuilder();
* translationServiceSettingsBuilder
* .translateTextSettings()
* .setRetrySettings(
* translationServiceSettingsBuilder
* .translateTextSettings()
* .getRetrySettings()
* .toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* TranslationServiceSettings translationServiceSettings =
* translationServiceSettingsBuilder.build();
* }
*/
@Generated("by gapic-generator-java")
public class TranslationServiceSettings extends ClientSettings {
/** Returns the object with the settings used for calls to translateText. */
public UnaryCallSettings translateTextSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).translateTextSettings();
}
/** Returns the object with the settings used for calls to detectLanguage. */
public UnaryCallSettings detectLanguageSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).detectLanguageSettings();
}
/** Returns the object with the settings used for calls to getSupportedLanguages. */
public UnaryCallSettings
getSupportedLanguagesSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).getSupportedLanguagesSettings();
}
/** Returns the object with the settings used for calls to translateDocument. */
public UnaryCallSettings
translateDocumentSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).translateDocumentSettings();
}
/** Returns the object with the settings used for calls to batchTranslateText. */
public UnaryCallSettings batchTranslateTextSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).batchTranslateTextSettings();
}
/** Returns the object with the settings used for calls to batchTranslateText. */
public OperationCallSettings<
BatchTranslateTextRequest, BatchTranslateResponse, BatchTranslateMetadata>
batchTranslateTextOperationSettings() {
return ((TranslationServiceStubSettings) getStubSettings())
.batchTranslateTextOperationSettings();
}
/** Returns the object with the settings used for calls to batchTranslateDocument. */
public UnaryCallSettings
batchTranslateDocumentSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).batchTranslateDocumentSettings();
}
/** Returns the object with the settings used for calls to batchTranslateDocument. */
public OperationCallSettings<
BatchTranslateDocumentRequest,
BatchTranslateDocumentResponse,
BatchTranslateDocumentMetadata>
batchTranslateDocumentOperationSettings() {
return ((TranslationServiceStubSettings) getStubSettings())
.batchTranslateDocumentOperationSettings();
}
/** Returns the object with the settings used for calls to createGlossary. */
public UnaryCallSettings createGlossarySettings() {
return ((TranslationServiceStubSettings) getStubSettings()).createGlossarySettings();
}
/** Returns the object with the settings used for calls to createGlossary. */
public OperationCallSettings
createGlossaryOperationSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).createGlossaryOperationSettings();
}
/** Returns the object with the settings used for calls to listGlossaries. */
public PagedCallSettings<
ListGlossariesRequest, ListGlossariesResponse, ListGlossariesPagedResponse>
listGlossariesSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).listGlossariesSettings();
}
/** Returns the object with the settings used for calls to getGlossary. */
public UnaryCallSettings getGlossarySettings() {
return ((TranslationServiceStubSettings) getStubSettings()).getGlossarySettings();
}
/** Returns the object with the settings used for calls to deleteGlossary. */
public UnaryCallSettings deleteGlossarySettings() {
return ((TranslationServiceStubSettings) getStubSettings()).deleteGlossarySettings();
}
/** Returns the object with the settings used for calls to deleteGlossary. */
public OperationCallSettings<
DeleteGlossaryRequest, DeleteGlossaryResponse, DeleteGlossaryMetadata>
deleteGlossaryOperationSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).deleteGlossaryOperationSettings();
}
/** Returns the object with the settings used for calls to createAdaptiveMtDataset. */
public UnaryCallSettings
createAdaptiveMtDatasetSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).createAdaptiveMtDatasetSettings();
}
/** Returns the object with the settings used for calls to deleteAdaptiveMtDataset. */
public UnaryCallSettings
deleteAdaptiveMtDatasetSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).deleteAdaptiveMtDatasetSettings();
}
/** Returns the object with the settings used for calls to getAdaptiveMtDataset. */
public UnaryCallSettings
getAdaptiveMtDatasetSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).getAdaptiveMtDatasetSettings();
}
/** Returns the object with the settings used for calls to listAdaptiveMtDatasets. */
public PagedCallSettings<
ListAdaptiveMtDatasetsRequest,
ListAdaptiveMtDatasetsResponse,
ListAdaptiveMtDatasetsPagedResponse>
listAdaptiveMtDatasetsSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).listAdaptiveMtDatasetsSettings();
}
/** Returns the object with the settings used for calls to adaptiveMtTranslate. */
public UnaryCallSettings
adaptiveMtTranslateSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).adaptiveMtTranslateSettings();
}
/** Returns the object with the settings used for calls to getAdaptiveMtFile. */
public UnaryCallSettings getAdaptiveMtFileSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).getAdaptiveMtFileSettings();
}
/** Returns the object with the settings used for calls to deleteAdaptiveMtFile. */
public UnaryCallSettings deleteAdaptiveMtFileSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).deleteAdaptiveMtFileSettings();
}
/** Returns the object with the settings used for calls to importAdaptiveMtFile. */
public UnaryCallSettings
importAdaptiveMtFileSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).importAdaptiveMtFileSettings();
}
/** Returns the object with the settings used for calls to listAdaptiveMtFiles. */
public PagedCallSettings<
ListAdaptiveMtFilesRequest, ListAdaptiveMtFilesResponse, ListAdaptiveMtFilesPagedResponse>
listAdaptiveMtFilesSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).listAdaptiveMtFilesSettings();
}
/** Returns the object with the settings used for calls to listAdaptiveMtSentences. */
public PagedCallSettings<
ListAdaptiveMtSentencesRequest,
ListAdaptiveMtSentencesResponse,
ListAdaptiveMtSentencesPagedResponse>
listAdaptiveMtSentencesSettings() {
return ((TranslationServiceStubSettings) getStubSettings()).listAdaptiveMtSentencesSettings();
}
public static final TranslationServiceSettings create(TranslationServiceStubSettings stub)
throws IOException {
return new TranslationServiceSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return TranslationServiceStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return TranslationServiceStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return TranslationServiceStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return TranslationServiceStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return TranslationServiceStubSettings.defaultGrpcTransportProviderBuilder();
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return TranslationServiceStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return TranslationServiceStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return TranslationServiceStubSettings.defaultApiClientHeaderProviderBuilder();
}
/** Returns a new gRPC builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** Returns a new REST builder for this class. */
public static Builder newHttpJsonBuilder() {
return Builder.createHttpJsonDefault();
}
/** Returns a new builder for this class. */
public static Builder newBuilder(ClientContext clientContext) {
return new Builder(clientContext);
}
/** Returns a builder containing all the values of this settings class. */
public Builder toBuilder() {
return new Builder(this);
}
protected TranslationServiceSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for TranslationServiceSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(TranslationServiceStubSettings.newBuilder(clientContext));
}
protected Builder(TranslationServiceSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(TranslationServiceStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(TranslationServiceStubSettings.newBuilder());
}
private static Builder createHttpJsonDefault() {
return new Builder(TranslationServiceStubSettings.newHttpJsonBuilder());
}
public TranslationServiceStubSettings.Builder getStubSettingsBuilder() {
return ((TranslationServiceStubSettings.Builder) getStubSettings());
}
/**
* Applies the given settings updater function to all of the unary API methods in this service.
*
* Note: This method does not support applying settings to streaming methods.
*/
public Builder applyToAllUnaryMethods(
ApiFunction, Void> settingsUpdater) {
super.applyToAllUnaryMethods(
getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
return this;
}
/** Returns the builder for the settings used for calls to translateText. */
public UnaryCallSettings.Builder
translateTextSettings() {
return getStubSettingsBuilder().translateTextSettings();
}
/** Returns the builder for the settings used for calls to detectLanguage. */
public UnaryCallSettings.Builder
detectLanguageSettings() {
return getStubSettingsBuilder().detectLanguageSettings();
}
/** Returns the builder for the settings used for calls to getSupportedLanguages. */
public UnaryCallSettings.Builder
getSupportedLanguagesSettings() {
return getStubSettingsBuilder().getSupportedLanguagesSettings();
}
/** Returns the builder for the settings used for calls to translateDocument. */
public UnaryCallSettings.Builder
translateDocumentSettings() {
return getStubSettingsBuilder().translateDocumentSettings();
}
/** Returns the builder for the settings used for calls to batchTranslateText. */
public UnaryCallSettings.Builder
batchTranslateTextSettings() {
return getStubSettingsBuilder().batchTranslateTextSettings();
}
/** Returns the builder for the settings used for calls to batchTranslateText. */
public OperationCallSettings.Builder<
BatchTranslateTextRequest, BatchTranslateResponse, BatchTranslateMetadata>
batchTranslateTextOperationSettings() {
return getStubSettingsBuilder().batchTranslateTextOperationSettings();
}
/** Returns the builder for the settings used for calls to batchTranslateDocument. */
public UnaryCallSettings.Builder
batchTranslateDocumentSettings() {
return getStubSettingsBuilder().batchTranslateDocumentSettings();
}
/** Returns the builder for the settings used for calls to batchTranslateDocument. */
public OperationCallSettings.Builder<
BatchTranslateDocumentRequest,
BatchTranslateDocumentResponse,
BatchTranslateDocumentMetadata>
batchTranslateDocumentOperationSettings() {
return getStubSettingsBuilder().batchTranslateDocumentOperationSettings();
}
/** Returns the builder for the settings used for calls to createGlossary. */
public UnaryCallSettings.Builder createGlossarySettings() {
return getStubSettingsBuilder().createGlossarySettings();
}
/** Returns the builder for the settings used for calls to createGlossary. */
public OperationCallSettings.Builder
createGlossaryOperationSettings() {
return getStubSettingsBuilder().createGlossaryOperationSettings();
}
/** Returns the builder for the settings used for calls to listGlossaries. */
public PagedCallSettings.Builder<
ListGlossariesRequest, ListGlossariesResponse, ListGlossariesPagedResponse>
listGlossariesSettings() {
return getStubSettingsBuilder().listGlossariesSettings();
}
/** Returns the builder for the settings used for calls to getGlossary. */
public UnaryCallSettings.Builder getGlossarySettings() {
return getStubSettingsBuilder().getGlossarySettings();
}
/** Returns the builder for the settings used for calls to deleteGlossary. */
public UnaryCallSettings.Builder deleteGlossarySettings() {
return getStubSettingsBuilder().deleteGlossarySettings();
}
/** Returns the builder for the settings used for calls to deleteGlossary. */
public OperationCallSettings.Builder<
DeleteGlossaryRequest, DeleteGlossaryResponse, DeleteGlossaryMetadata>
deleteGlossaryOperationSettings() {
return getStubSettingsBuilder().deleteGlossaryOperationSettings();
}
/** Returns the builder for the settings used for calls to createAdaptiveMtDataset. */
public UnaryCallSettings.Builder
createAdaptiveMtDatasetSettings() {
return getStubSettingsBuilder().createAdaptiveMtDatasetSettings();
}
/** Returns the builder for the settings used for calls to deleteAdaptiveMtDataset. */
public UnaryCallSettings.Builder
deleteAdaptiveMtDatasetSettings() {
return getStubSettingsBuilder().deleteAdaptiveMtDatasetSettings();
}
/** Returns the builder for the settings used for calls to getAdaptiveMtDataset. */
public UnaryCallSettings.Builder
getAdaptiveMtDatasetSettings() {
return getStubSettingsBuilder().getAdaptiveMtDatasetSettings();
}
/** Returns the builder for the settings used for calls to listAdaptiveMtDatasets. */
public PagedCallSettings.Builder<
ListAdaptiveMtDatasetsRequest,
ListAdaptiveMtDatasetsResponse,
ListAdaptiveMtDatasetsPagedResponse>
listAdaptiveMtDatasetsSettings() {
return getStubSettingsBuilder().listAdaptiveMtDatasetsSettings();
}
/** Returns the builder for the settings used for calls to adaptiveMtTranslate. */
public UnaryCallSettings.Builder
adaptiveMtTranslateSettings() {
return getStubSettingsBuilder().adaptiveMtTranslateSettings();
}
/** Returns the builder for the settings used for calls to getAdaptiveMtFile. */
public UnaryCallSettings.Builder
getAdaptiveMtFileSettings() {
return getStubSettingsBuilder().getAdaptiveMtFileSettings();
}
/** Returns the builder for the settings used for calls to deleteAdaptiveMtFile. */
public UnaryCallSettings.Builder
deleteAdaptiveMtFileSettings() {
return getStubSettingsBuilder().deleteAdaptiveMtFileSettings();
}
/** Returns the builder for the settings used for calls to importAdaptiveMtFile. */
public UnaryCallSettings.Builder
importAdaptiveMtFileSettings() {
return getStubSettingsBuilder().importAdaptiveMtFileSettings();
}
/** Returns the builder for the settings used for calls to listAdaptiveMtFiles. */
public PagedCallSettings.Builder<
ListAdaptiveMtFilesRequest,
ListAdaptiveMtFilesResponse,
ListAdaptiveMtFilesPagedResponse>
listAdaptiveMtFilesSettings() {
return getStubSettingsBuilder().listAdaptiveMtFilesSettings();
}
/** Returns the builder for the settings used for calls to listAdaptiveMtSentences. */
public PagedCallSettings.Builder<
ListAdaptiveMtSentencesRequest,
ListAdaptiveMtSentencesResponse,
ListAdaptiveMtSentencesPagedResponse>
listAdaptiveMtSentencesSettings() {
return getStubSettingsBuilder().listAdaptiveMtSentencesSettings();
}
@Override
public TranslationServiceSettings build() throws IOException {
return new TranslationServiceSettings(this);
}
}
}