com.google.cloud.discoveryengine.v1beta

Class ConversationalSearchServiceSettings

java.lang.Object

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

com.google.cloud.discoveryengine.v1beta.ConversationalSearchServiceSettings

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

Settings class to configure an instance of ConversationalSearchServiceClient.

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 converseConversation 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
 ConversationalSearchServiceSettings.Builder conversationalSearchServiceSettingsBuilder =
     ConversationalSearchServiceSettings.newBuilder();
 conversationalSearchServiceSettingsBuilder
     .converseConversationSettings()
     .setRetrySettings(
         conversationalSearchServiceSettingsBuilder
             .converseConversationSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ConversationalSearchServiceSettings conversationalSearchServiceSettings =
     conversationalSearchServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<AnswerQueryRequest,AnswerQueryResponse>	answerQuerySettings() Returns the object with the settings used for calls to answerQuery.
com.google.api.gax.rpc.UnaryCallSettings<ConverseConversationRequest,ConverseConversationResponse>	converseConversationSettings() Returns the object with the settings used for calls to converseConversation.
static ConversationalSearchServiceSettings	create(ConversationalSearchServiceStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateConversationRequest,Conversation>	createConversationSettings() Returns the object with the settings used for calls to createConversation.
com.google.api.gax.rpc.UnaryCallSettings<CreateSessionRequest,Session>	createSessionSettings() Returns the object with the settings used for calls to createSession.
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()
com.google.api.gax.rpc.UnaryCallSettings<DeleteConversationRequest,com.google.protobuf.Empty>	deleteConversationSettings() Returns the object with the settings used for calls to deleteConversation.
com.google.api.gax.rpc.UnaryCallSettings<DeleteSessionRequest,com.google.protobuf.Empty>	deleteSessionSettings() Returns the object with the settings used for calls to deleteSession.
com.google.api.gax.rpc.UnaryCallSettings<GetAnswerRequest,Answer>	getAnswerSettings() Returns the object with the settings used for calls to getAnswer.
com.google.api.gax.rpc.UnaryCallSettings<GetConversationRequest,Conversation>	getConversationSettings() Returns the object with the settings used for calls to getConversation.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetSessionRequest,Session>	getSessionSettings() Returns the object with the settings used for calls to getSession.
com.google.api.gax.rpc.PagedCallSettings<ListConversationsRequest,ListConversationsResponse,ConversationalSearchServiceClient.ListConversationsPagedResponse>	listConversationsSettings() Returns the object with the settings used for calls to listConversations.
com.google.api.gax.rpc.PagedCallSettings<ListSessionsRequest,ListSessionsResponse,ConversationalSearchServiceClient.ListSessionsPagedResponse>	listSessionsSettings() Returns the object with the settings used for calls to listSessions.
static ConversationalSearchServiceSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static ConversationalSearchServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static ConversationalSearchServiceSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
ConversationalSearchServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateConversationRequest,Conversation>	updateConversationSettings() Returns the object with the settings used for calls to updateConversation.
com.google.api.gax.rpc.UnaryCallSettings<UpdateSessionRequest,Session>	updateSessionSettings() Returns the object with the settings used for calls to updateSession.

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

ConversationalSearchServiceSettings

protected ConversationalSearchServiceSettings(ConversationalSearchServiceSettings.Builder settingsBuilder)
                                       throws IOException

Throws:

IOException

Method Detail

converseConversationSettings

public com.google.api.gax.rpc.UnaryCallSettings<ConverseConversationRequest,ConverseConversationResponse> converseConversationSettings()

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

createConversationSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateConversationRequest,Conversation> createConversationSettings()

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

deleteConversationSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteConversationRequest,com.google.protobuf.Empty> deleteConversationSettings()

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

updateConversationSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateConversationRequest,Conversation> updateConversationSettings()

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

getConversationSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetConversationRequest,Conversation> getConversationSettings()

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

listConversationsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListConversationsRequest,ListConversationsResponse,ConversationalSearchServiceClient.ListConversationsPagedResponse> listConversationsSettings()

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

answerQuerySettings

public com.google.api.gax.rpc.UnaryCallSettings<AnswerQueryRequest,AnswerQueryResponse> answerQuerySettings()

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

getAnswerSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetAnswerRequest,Answer> getAnswerSettings()

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

createSessionSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateSessionRequest,Session> createSessionSettings()

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

deleteSessionSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteSessionRequest,com.google.protobuf.Empty> deleteSessionSettings()

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

updateSessionSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateSessionRequest,Session> updateSessionSettings()

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

getSessionSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetSessionRequest,Session> getSessionSettings()

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

listSessionsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListSessionsRequest,ListSessionsResponse,ConversationalSearchServiceClient.ListSessionsPagedResponse> listSessionsSettings()

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

create

public static final ConversationalSearchServiceSettings create(ConversationalSearchServiceStubSettings 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 ConversationalSearchServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static ConversationalSearchServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public ConversationalSearchServiceSettings.Builder toBuilder()

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

Specified by:

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