com.google.cloud.texttospeech.v1.TextToSpeechSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-texttospeech Show documentation
Java idiomatic client for Google Cloud Text-to-Speech
There is a newer version: 2.55.0
Show newest version
/*
 * 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.texttospeech.v1;

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.StreamingCallSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.cloud.texttospeech.v1.stub.TextToSpeechStubSettings;
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 TextToSpeechClient}.
 *
 * The default instance has everything set to sensible defaults:
 *
 * 

 *   The default service address (texttospeech.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 listVoices 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
 * TextToSpeechSettings.Builder textToSpeechSettingsBuilder = TextToSpeechSettings.newBuilder();
 * textToSpeechSettingsBuilder
 *     .listVoicesSettings()
 *     .setRetrySettings(
 *         textToSpeechSettingsBuilder
 *             .listVoicesSettings()
 *             .getRetrySettings()
 *             .toBuilder()
 *             .setTotalTimeout(Duration.ofSeconds(30))
 *             .build());
 * TextToSpeechSettings textToSpeechSettings = textToSpeechSettingsBuilder.build();
 * }
 */
@Generated("by gapic-generator-java")
public class TextToSpeechSettings extends ClientSettings {

  /** Returns the object with the settings used for calls to listVoices. */
  public UnaryCallSettings listVoicesSettings() {
    return ((TextToSpeechStubSettings) getStubSettings()).listVoicesSettings();
  }

  /** Returns the object with the settings used for calls to synthesizeSpeech. */
  public UnaryCallSettings
      synthesizeSpeechSettings() {
    return ((TextToSpeechStubSettings) getStubSettings()).synthesizeSpeechSettings();
  }

  /** Returns the object with the settings used for calls to streamingSynthesize. */
  public StreamingCallSettings
      streamingSynthesizeSettings() {
    return ((TextToSpeechStubSettings) getStubSettings()).streamingSynthesizeSettings();
  }

  public static final TextToSpeechSettings create(TextToSpeechStubSettings stub)
      throws IOException {
    return new TextToSpeechSettings.Builder(stub.toBuilder()).build();
  }

  /** Returns a builder for the default ExecutorProvider for this service. */
  public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
    return TextToSpeechStubSettings.defaultExecutorProviderBuilder();
  }

  /** Returns the default service endpoint. */
  public static String getDefaultEndpoint() {
    return TextToSpeechStubSettings.getDefaultEndpoint();
  }

  /** Returns the default service scopes. */
  public static List getDefaultServiceScopes() {
    return TextToSpeechStubSettings.getDefaultServiceScopes();
  }

  /** Returns a builder for the default credentials for this service. */
  public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
    return TextToSpeechStubSettings.defaultCredentialsProviderBuilder();
  }

  /** Returns a builder for the default gRPC ChannelProvider for this service. */
  public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
    return TextToSpeechStubSettings.defaultGrpcTransportProviderBuilder();
  }

  /** Returns a builder for the default REST ChannelProvider for this service. */
  @BetaApi
  public static InstantiatingHttpJsonChannelProvider.Builder
      defaultHttpJsonTransportProviderBuilder() {
    return TextToSpeechStubSettings.defaultHttpJsonTransportProviderBuilder();
  }

  public static TransportChannelProvider defaultTransportChannelProvider() {
    return TextToSpeechStubSettings.defaultTransportChannelProvider();
  }

  public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
    return TextToSpeechStubSettings.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 TextToSpeechSettings(Builder settingsBuilder) throws IOException {
    super(settingsBuilder);
  }

  /** Builder for TextToSpeechSettings. */
  public static class Builder extends ClientSettings.Builder {

    protected Builder() throws IOException {
      this(((ClientContext) null));
    }

    protected Builder(ClientContext clientContext) {
      super(TextToSpeechStubSettings.newBuilder(clientContext));
    }

    protected Builder(TextToSpeechSettings settings) {
      super(settings.getStubSettings().toBuilder());
    }

    protected Builder(TextToSpeechStubSettings.Builder stubSettings) {
      super(stubSettings);
    }

    private static Builder createDefault() {
      return new Builder(TextToSpeechStubSettings.newBuilder());
    }

    private static Builder createHttpJsonDefault() {
      return new Builder(TextToSpeechStubSettings.newHttpJsonBuilder());
    }

    public TextToSpeechStubSettings.Builder getStubSettingsBuilder() {
      return ((TextToSpeechStubSettings.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 listVoices. */
    public UnaryCallSettings.Builder listVoicesSettings() {
      return getStubSettingsBuilder().listVoicesSettings();
    }

    /** Returns the builder for the settings used for calls to synthesizeSpeech. */
    public UnaryCallSettings.Builder
        synthesizeSpeechSettings() {
      return getStubSettingsBuilder().synthesizeSpeechSettings();
    }

    /** Returns the builder for the settings used for calls to streamingSynthesize. */
    public StreamingCallSettings.Builder
        streamingSynthesizeSettings() {
      return getStubSettingsBuilder().streamingSynthesizeSettings();
    }

    @Override
    public TextToSpeechSettings build() throws IOException {
      return new TextToSpeechSettings(this);
    }
  }
}