com.google.cloud.discoveryengine.v1

Class CompletionServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<CompletionServiceSettings>

com.google.cloud.discoveryengine.v1.CompletionServiceSettings

@Generated(value="by gapic-generator-java")
public class CompletionServiceSettings
extends com.google.api.gax.rpc.ClientSettings<CompletionServiceSettings>

Settings class to configure an instance of CompletionServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (discoveryengine.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 completeQuery to 30 seconds:

 // 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
 CompletionServiceSettings.Builder completionServiceSettingsBuilder =
     CompletionServiceSettings.newBuilder();
 completionServiceSettingsBuilder
     .completeQuerySettings()
     .setRetrySettings(
         completionServiceSettingsBuilder
             .completeQuerySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CompletionServiceSettings completionServiceSettings = completionServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompletionServiceSettings.Builder Builder for CompletionServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompletionServiceSettings(CompletionServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<CompleteQueryRequest,CompleteQueryResponse>	completeQuerySettings() Returns the object with the settings used for calls to completeQuery.
static CompletionServiceSettings	create(CompletionServiceStubSettings stub)
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.OperationCallSettings<ImportCompletionSuggestionsRequest,ImportCompletionSuggestionsResponse,ImportCompletionSuggestionsMetadata>	importCompletionSuggestionsOperationSettings() Returns the object with the settings used for calls to importCompletionSuggestions.
com.google.api.gax.rpc.UnaryCallSettings<ImportCompletionSuggestionsRequest,com.google.longrunning.Operation>	importCompletionSuggestionsSettings() Returns the object with the settings used for calls to importCompletionSuggestions.
com.google.api.gax.rpc.OperationCallSettings<ImportSuggestionDenyListEntriesRequest,ImportSuggestionDenyListEntriesResponse,ImportSuggestionDenyListEntriesMetadata>	importSuggestionDenyListEntriesOperationSettings() Returns the object with the settings used for calls to importSuggestionDenyListEntries.
com.google.api.gax.rpc.UnaryCallSettings<ImportSuggestionDenyListEntriesRequest,com.google.longrunning.Operation>	importSuggestionDenyListEntriesSettings() Returns the object with the settings used for calls to importSuggestionDenyListEntries.
static CompletionServiceSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static CompletionServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static CompletionServiceSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.OperationCallSettings<PurgeCompletionSuggestionsRequest,PurgeCompletionSuggestionsResponse,PurgeCompletionSuggestionsMetadata>	purgeCompletionSuggestionsOperationSettings() Returns the object with the settings used for calls to purgeCompletionSuggestions.
com.google.api.gax.rpc.UnaryCallSettings<PurgeCompletionSuggestionsRequest,com.google.longrunning.Operation>	purgeCompletionSuggestionsSettings() Returns the object with the settings used for calls to purgeCompletionSuggestions.
com.google.api.gax.rpc.OperationCallSettings<PurgeSuggestionDenyListEntriesRequest,PurgeSuggestionDenyListEntriesResponse,PurgeSuggestionDenyListEntriesMetadata>	purgeSuggestionDenyListEntriesOperationSettings() Returns the object with the settings used for calls to purgeSuggestionDenyListEntries.
com.google.api.gax.rpc.UnaryCallSettings<PurgeSuggestionDenyListEntriesRequest,com.google.longrunning.Operation>	purgeSuggestionDenyListEntriesSettings() Returns the object with the settings used for calls to purgeSuggestionDenyListEntries.
CompletionServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CompletionServiceSettings

protected CompletionServiceSettings(CompletionServiceSettings.Builder settingsBuilder)
                             throws IOException

Throws:

IOException

Method Detail

completeQuerySettings

public com.google.api.gax.rpc.UnaryCallSettings<CompleteQueryRequest,CompleteQueryResponse> completeQuerySettings()

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

importSuggestionDenyListEntriesSettings

public com.google.api.gax.rpc.UnaryCallSettings<ImportSuggestionDenyListEntriesRequest,com.google.longrunning.Operation> importSuggestionDenyListEntriesSettings()

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

importSuggestionDenyListEntriesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ImportSuggestionDenyListEntriesRequest,ImportSuggestionDenyListEntriesResponse,ImportSuggestionDenyListEntriesMetadata> importSuggestionDenyListEntriesOperationSettings()

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

purgeSuggestionDenyListEntriesSettings

public com.google.api.gax.rpc.UnaryCallSettings<PurgeSuggestionDenyListEntriesRequest,com.google.longrunning.Operation> purgeSuggestionDenyListEntriesSettings()

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

purgeSuggestionDenyListEntriesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<PurgeSuggestionDenyListEntriesRequest,PurgeSuggestionDenyListEntriesResponse,PurgeSuggestionDenyListEntriesMetadata> purgeSuggestionDenyListEntriesOperationSettings()

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

importCompletionSuggestionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<ImportCompletionSuggestionsRequest,com.google.longrunning.Operation> importCompletionSuggestionsSettings()

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

importCompletionSuggestionsOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ImportCompletionSuggestionsRequest,ImportCompletionSuggestionsResponse,ImportCompletionSuggestionsMetadata> importCompletionSuggestionsOperationSettings()

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

purgeCompletionSuggestionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<PurgeCompletionSuggestionsRequest,com.google.longrunning.Operation> purgeCompletionSuggestionsSettings()

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

purgeCompletionSuggestionsOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<PurgeCompletionSuggestionsRequest,PurgeCompletionSuggestionsResponse,PurgeCompletionSuggestionsMetadata> purgeCompletionSuggestionsOperationSettings()

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

create

public static final CompletionServiceSettings create(CompletionServiceStubSettings stub)
                                              throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static CompletionServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static CompletionServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static CompletionServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public CompletionServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<CompletionServiceSettings>