Class SpeechStubSettings (4.50.0) 

public class SpeechStubSettings extends StubSettings<SpeechStubSettings>

Settings class to configure an instance of SpeechStub.

The default instance has everything set to sensible defaults:

  • The default service address (speech.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 RetrySettings of getRecognizer:


 // 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
 SpeechStubSettings.Builder speechSettingsBuilder = SpeechStubSettings.newBuilder();
 speechSettingsBuilder
     .getRecognizerSettings()
     .setRetrySettings(
         speechSettingsBuilder
             .getRecognizerSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 SpeechStubSettings speechSettings = speechSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createRecognizer:


 // 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
 SpeechStubSettings.Builder speechSettingsBuilder = SpeechStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 speechSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > StubSettings > SpeechStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static SpeechStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
SpeechStubSettings.Builder

newBuilder(ClientContext clientContext)

public static SpeechStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
SpeechStubSettings.Builder

newHttpJsonBuilder()

public static SpeechStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
SpeechStubSettings.Builder

Constructors

SpeechStubSettings(SpeechStubSettings.Builder settingsBuilder)

protected SpeechStubSettings(SpeechStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder SpeechStubSettings.Builder

Methods

batchRecognizeOperationSettings()

public OperationCallSettings<BatchRecognizeRequest,BatchRecognizeResponse,OperationMetadata> batchRecognizeOperationSettings()

Returns the object with the settings used for calls to batchRecognize.

Returns
Type Description
OperationCallSettings<BatchRecognizeRequest,BatchRecognizeResponse,OperationMetadata>

batchRecognizeSettings()

public UnaryCallSettings<BatchRecognizeRequest,Operation> batchRecognizeSettings()

Returns the object with the settings used for calls to batchRecognize.

Returns
Type Description
UnaryCallSettings<BatchRecognizeRequest,Operation>

createCustomClassOperationSettings()

public OperationCallSettings<CreateCustomClassRequest,CustomClass,OperationMetadata> createCustomClassOperationSettings()

Returns the object with the settings used for calls to createCustomClass.

Returns
Type Description
OperationCallSettings<CreateCustomClassRequest,CustomClass,OperationMetadata>

createCustomClassSettings()

public UnaryCallSettings<CreateCustomClassRequest,Operation> createCustomClassSettings()

Returns the object with the settings used for calls to createCustomClass.

Returns
Type Description
UnaryCallSettings<CreateCustomClassRequest,Operation>

createPhraseSetOperationSettings()

public OperationCallSettings<CreatePhraseSetRequest,PhraseSet,OperationMetadata> createPhraseSetOperationSettings()

Returns the object with the settings used for calls to createPhraseSet.

Returns
Type Description
OperationCallSettings<CreatePhraseSetRequest,PhraseSet,OperationMetadata>

createPhraseSetSettings()

public UnaryCallSettings<CreatePhraseSetRequest,Operation> createPhraseSetSettings()

Returns the object with the settings used for calls to createPhraseSet.

Returns
Type Description
UnaryCallSettings<CreatePhraseSetRequest,Operation>

createRecognizerOperationSettings()

public OperationCallSettings<CreateRecognizerRequest,Recognizer,OperationMetadata> createRecognizerOperationSettings()

Returns the object with the settings used for calls to createRecognizer.

Returns
Type Description
OperationCallSettings<CreateRecognizerRequest,Recognizer,OperationMetadata>

createRecognizerSettings()

public UnaryCallSettings<CreateRecognizerRequest,Operation> createRecognizerSettings()

Returns the object with the settings used for calls to createRecognizer.

Returns
Type Description
UnaryCallSettings<CreateRecognizerRequest,Operation>

createStub()

public SpeechStub createStub()
Returns
Type Description
SpeechStub
Exceptions
Type Description
IOException

deleteCustomClassOperationSettings()

public OperationCallSettings<DeleteCustomClassRequest,CustomClass,OperationMetadata> deleteCustomClassOperationSettings()

Returns the object with the settings used for calls to deleteCustomClass.

Returns
Type Description
OperationCallSettings<DeleteCustomClassRequest,CustomClass,OperationMetadata>

deleteCustomClassSettings()

public UnaryCallSettings<DeleteCustomClassRequest,Operation> deleteCustomClassSettings()

Returns the object with the settings used for calls to deleteCustomClass.

Returns
Type Description
UnaryCallSettings<DeleteCustomClassRequest,Operation>

deletePhraseSetOperationSettings()

public OperationCallSettings<DeletePhraseSetRequest,PhraseSet,OperationMetadata> deletePhraseSetOperationSettings()

Returns the object with the settings used for calls to deletePhraseSet.

Returns
Type Description
OperationCallSettings<DeletePhraseSetRequest,PhraseSet,OperationMetadata>

deletePhraseSetSettings()

public UnaryCallSettings<DeletePhraseSetRequest,Operation> deletePhraseSetSettings()

Returns the object with the settings used for calls to deletePhraseSet.

Returns
Type Description
UnaryCallSettings<DeletePhraseSetRequest,Operation>

deleteRecognizerOperationSettings()

public OperationCallSettings<DeleteRecognizerRequest,Recognizer,OperationMetadata> deleteRecognizerOperationSettings()

Returns the object with the settings used for calls to deleteRecognizer.

Returns
Type Description
OperationCallSettings<DeleteRecognizerRequest,Recognizer,OperationMetadata>

deleteRecognizerSettings()

public UnaryCallSettings<DeleteRecognizerRequest,Operation> deleteRecognizerSettings()

Returns the object with the settings used for calls to deleteRecognizer.

Returns
Type Description
UnaryCallSettings<DeleteRecognizerRequest,Operation>

getConfigSettings()

public UnaryCallSettings<GetConfigRequest,Config> getConfigSettings()

Returns the object with the settings used for calls to getConfig.

Returns
Type Description
UnaryCallSettings<GetConfigRequest,Config>

getCustomClassSettings()

public UnaryCallSettings<GetCustomClassRequest,CustomClass> getCustomClassSettings()

Returns the object with the settings used for calls to getCustomClass.

Returns
Type Description
UnaryCallSettings<GetCustomClassRequest,CustomClass>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

Returns the object with the settings used for calls to getLocation.

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getPhraseSetSettings()

public UnaryCallSettings<GetPhraseSetRequest,PhraseSet> getPhraseSetSettings()

Returns the object with the settings used for calls to getPhraseSet.

Returns
Type Description
UnaryCallSettings<GetPhraseSetRequest,PhraseSet>

getRecognizerSettings()

public UnaryCallSettings<GetRecognizerRequest,Recognizer> getRecognizerSettings()

Returns the object with the settings used for calls to getRecognizer.

Returns
Type Description
UnaryCallSettings<GetRecognizerRequest,Recognizer>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

listCustomClassesSettings()

public PagedCallSettings<ListCustomClassesRequest,ListCustomClassesResponse,SpeechClient.ListCustomClassesPagedResponse> listCustomClassesSettings()

Returns the object with the settings used for calls to listCustomClasses.

Returns
Type Description
PagedCallSettings<ListCustomClassesRequest,ListCustomClassesResponse,ListCustomClassesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,SpeechClient.ListLocationsPagedResponse> listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listPhraseSetsSettings()

public PagedCallSettings<ListPhraseSetsRequest,ListPhraseSetsResponse,SpeechClient.ListPhraseSetsPagedResponse> listPhraseSetsSettings()

Returns the object with the settings used for calls to listPhraseSets.

Returns
Type Description
PagedCallSettings<ListPhraseSetsRequest,ListPhraseSetsResponse,ListPhraseSetsPagedResponse>

listRecognizersSettings()

public PagedCallSettings<ListRecognizersRequest,ListRecognizersResponse,SpeechClient.ListRecognizersPagedResponse> listRecognizersSettings()

Returns the object with the settings used for calls to listRecognizers.

Returns
Type Description
PagedCallSettings<ListRecognizersRequest,ListRecognizersResponse,ListRecognizersPagedResponse>

recognizeSettings()

public UnaryCallSettings<RecognizeRequest,RecognizeResponse> recognizeSettings()

Returns the object with the settings used for calls to recognize.

Returns
Type Description
UnaryCallSettings<RecognizeRequest,RecognizeResponse>

streamingRecognizeSettings()

public StreamingCallSettings<StreamingRecognizeRequest,StreamingRecognizeResponse> streamingRecognizeSettings()

Returns the object with the settings used for calls to streamingRecognize.

Returns
Type Description
StreamingCallSettings<StreamingRecognizeRequest,StreamingRecognizeResponse>

toBuilder()

public SpeechStubSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
SpeechStubSettings.Builder
Overrides

undeleteCustomClassOperationSettings()

public OperationCallSettings<UndeleteCustomClassRequest,CustomClass,OperationMetadata> undeleteCustomClassOperationSettings()

Returns the object with the settings used for calls to undeleteCustomClass.

Returns
Type Description
OperationCallSettings<UndeleteCustomClassRequest,CustomClass,OperationMetadata>

undeleteCustomClassSettings()

public UnaryCallSettings<UndeleteCustomClassRequest,Operation> undeleteCustomClassSettings()

Returns the object with the settings used for calls to undeleteCustomClass.

Returns
Type Description
UnaryCallSettings<UndeleteCustomClassRequest,Operation>

undeletePhraseSetOperationSettings()

public OperationCallSettings<UndeletePhraseSetRequest,PhraseSet,OperationMetadata> undeletePhraseSetOperationSettings()

Returns the object with the settings used for calls to undeletePhraseSet.

Returns
Type Description
OperationCallSettings<UndeletePhraseSetRequest,PhraseSet,OperationMetadata>

undeletePhraseSetSettings()

public UnaryCallSettings<UndeletePhraseSetRequest,Operation> undeletePhraseSetSettings()

Returns the object with the settings used for calls to undeletePhraseSet.

Returns
Type Description
UnaryCallSettings<UndeletePhraseSetRequest,Operation>

undeleteRecognizerOperationSettings()

public OperationCallSettings<UndeleteRecognizerRequest,Recognizer,OperationMetadata> undeleteRecognizerOperationSettings()

Returns the object with the settings used for calls to undeleteRecognizer.

Returns
Type Description
OperationCallSettings<UndeleteRecognizerRequest,Recognizer,OperationMetadata>

undeleteRecognizerSettings()

public UnaryCallSettings<UndeleteRecognizerRequest,Operation> undeleteRecognizerSettings()

Returns the object with the settings used for calls to undeleteRecognizer.

Returns
Type Description
UnaryCallSettings<UndeleteRecognizerRequest,Operation>

updateConfigSettings()

public UnaryCallSettings<UpdateConfigRequest,Config> updateConfigSettings()

Returns the object with the settings used for calls to updateConfig.

Returns
Type Description
UnaryCallSettings<UpdateConfigRequest,Config>

updateCustomClassOperationSettings()

public OperationCallSettings<UpdateCustomClassRequest,CustomClass,OperationMetadata> updateCustomClassOperationSettings()

Returns the object with the settings used for calls to updateCustomClass.

Returns
Type Description
OperationCallSettings<UpdateCustomClassRequest,CustomClass,OperationMetadata>

updateCustomClassSettings()

public UnaryCallSettings<UpdateCustomClassRequest,Operation> updateCustomClassSettings()

Returns the object with the settings used for calls to updateCustomClass.

Returns
Type Description
UnaryCallSettings<UpdateCustomClassRequest,Operation>

updatePhraseSetOperationSettings()

public OperationCallSettings<UpdatePhraseSetRequest,PhraseSet,OperationMetadata> updatePhraseSetOperationSettings()

Returns the object with the settings used for calls to updatePhraseSet.

Returns
Type Description
OperationCallSettings<UpdatePhraseSetRequest,PhraseSet,OperationMetadata>

updatePhraseSetSettings()

public UnaryCallSettings<UpdatePhraseSetRequest,Operation> updatePhraseSetSettings()

Returns the object with the settings used for calls to updatePhraseSet.

Returns
Type Description
UnaryCallSettings<UpdatePhraseSetRequest,Operation>

updateRecognizerOperationSettings()

public OperationCallSettings<UpdateRecognizerRequest,Recognizer,OperationMetadata> updateRecognizerOperationSettings()

Returns the object with the settings used for calls to updateRecognizer.

Returns
Type Description
OperationCallSettings<UpdateRecognizerRequest,Recognizer,OperationMetadata>

updateRecognizerSettings()

public UnaryCallSettings<UpdateRecognizerRequest,Operation> updateRecognizerSettings()

Returns the object with the settings used for calls to updateRecognizer.

Returns
Type Description
UnaryCallSettings<UpdateRecognizerRequest,Operation>