com.google.cloud.discoveryengine.v1beta.stub.ConversationalSearchServiceStubSettings Maven / Gradle / Ivy
/*
* 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.discoveryengine.v1beta.stub;
import static com.google.cloud.discoveryengine.v1beta.ConversationalSearchServiceClient.ListConversationsPagedResponse;
import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GaxProperties;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.grpc.GaxGrpcProperties;
import com.google.api.gax.grpc.GrpcTransportChannel;
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
import com.google.api.gax.httpjson.GaxHttpJsonProperties;
import com.google.api.gax.httpjson.HttpJsonTransportChannel;
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
import com.google.api.gax.retrying.RetrySettings;
import com.google.api.gax.rpc.ApiCallContext;
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.PagedListDescriptor;
import com.google.api.gax.rpc.PagedListResponseFactory;
import com.google.api.gax.rpc.StatusCode;
import com.google.api.gax.rpc.StubSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.discoveryengine.v1beta.Conversation;
import com.google.cloud.discoveryengine.v1beta.ConverseConversationRequest;
import com.google.cloud.discoveryengine.v1beta.ConverseConversationResponse;
import com.google.cloud.discoveryengine.v1beta.CreateConversationRequest;
import com.google.cloud.discoveryengine.v1beta.DeleteConversationRequest;
import com.google.cloud.discoveryengine.v1beta.GetConversationRequest;
import com.google.cloud.discoveryengine.v1beta.ListConversationsRequest;
import com.google.cloud.discoveryengine.v1beta.ListConversationsResponse;
import com.google.cloud.discoveryengine.v1beta.UpdateConversationRequest;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Lists;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import javax.annotation.Generated;
import org.threeten.bp.Duration;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Settings class to configure an instance of {@link ConversationalSearchServiceStub}.
*
* 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:
*
*
{@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
* ConversationalSearchServiceStubSettings.Builder conversationalSearchServiceSettingsBuilder =
* ConversationalSearchServiceStubSettings.newBuilder();
* conversationalSearchServiceSettingsBuilder
* .converseConversationSettings()
* .setRetrySettings(
* conversationalSearchServiceSettingsBuilder
* .converseConversationSettings()
* .getRetrySettings()
* .toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* ConversationalSearchServiceStubSettings conversationalSearchServiceSettings =
* conversationalSearchServiceSettingsBuilder.build();
* }
*/
@BetaApi
@Generated("by gapic-generator-java")
public class ConversationalSearchServiceStubSettings
extends StubSettings {
/** The default scopes of the service. */
private static final ImmutableList DEFAULT_SERVICE_SCOPES =
ImmutableList.builder().add("https://www.googleapis.com/auth/cloud-platform").build();
private final UnaryCallSettings
converseConversationSettings;
private final UnaryCallSettings
createConversationSettings;
private final UnaryCallSettings deleteConversationSettings;
private final UnaryCallSettings
updateConversationSettings;
private final UnaryCallSettings getConversationSettings;
private final PagedCallSettings<
ListConversationsRequest, ListConversationsResponse, ListConversationsPagedResponse>
listConversationsSettings;
private static final PagedListDescriptor<
ListConversationsRequest, ListConversationsResponse, Conversation>
LIST_CONVERSATIONS_PAGE_STR_DESC =
new PagedListDescriptor<
ListConversationsRequest, ListConversationsResponse, Conversation>() {
@Override
public String emptyToken() {
return "";
}
@Override
public ListConversationsRequest injectToken(
ListConversationsRequest payload, String token) {
return ListConversationsRequest.newBuilder(payload).setPageToken(token).build();
}
@Override
public ListConversationsRequest injectPageSize(
ListConversationsRequest payload, int pageSize) {
return ListConversationsRequest.newBuilder(payload).setPageSize(pageSize).build();
}
@Override
public Integer extractPageSize(ListConversationsRequest payload) {
return payload.getPageSize();
}
@Override
public String extractNextToken(ListConversationsResponse payload) {
return payload.getNextPageToken();
}
@Override
public Iterable extractResources(ListConversationsResponse payload) {
return payload.getConversationsList() == null
? ImmutableList.of()
: payload.getConversationsList();
}
};
private static final PagedListResponseFactory<
ListConversationsRequest, ListConversationsResponse, ListConversationsPagedResponse>
LIST_CONVERSATIONS_PAGE_STR_FACT =
new PagedListResponseFactory<
ListConversationsRequest,
ListConversationsResponse,
ListConversationsPagedResponse>() {
@Override
public ApiFuture getFuturePagedResponse(
UnaryCallable callable,
ListConversationsRequest request,
ApiCallContext context,
ApiFuture futureResponse) {
PageContext
pageContext =
PageContext.create(
callable, LIST_CONVERSATIONS_PAGE_STR_DESC, request, context);
return ListConversationsPagedResponse.createAsync(pageContext, futureResponse);
}
};
/** Returns the object with the settings used for calls to converseConversation. */
public UnaryCallSettings
converseConversationSettings() {
return converseConversationSettings;
}
/** Returns the object with the settings used for calls to createConversation. */
public UnaryCallSettings createConversationSettings() {
return createConversationSettings;
}
/** Returns the object with the settings used for calls to deleteConversation. */
public UnaryCallSettings deleteConversationSettings() {
return deleteConversationSettings;
}
/** Returns the object with the settings used for calls to updateConversation. */
public UnaryCallSettings updateConversationSettings() {
return updateConversationSettings;
}
/** Returns the object with the settings used for calls to getConversation. */
public UnaryCallSettings getConversationSettings() {
return getConversationSettings;
}
/** Returns the object with the settings used for calls to listConversations. */
public PagedCallSettings<
ListConversationsRequest, ListConversationsResponse, ListConversationsPagedResponse>
listConversationsSettings() {
return listConversationsSettings;
}
public ConversationalSearchServiceStub createStub() throws IOException {
if (getTransportChannelProvider()
.getTransportName()
.equals(GrpcTransportChannel.getGrpcTransportName())) {
return GrpcConversationalSearchServiceStub.create(this);
}
if (getTransportChannelProvider()
.getTransportName()
.equals(HttpJsonTransportChannel.getHttpJsonTransportName())) {
return HttpJsonConversationalSearchServiceStub.create(this);
}
throw new UnsupportedOperationException(
String.format(
"Transport not supported: %s", getTransportChannelProvider().getTransportName()));
}
/** Returns the endpoint set by the user or the the service's default endpoint. */
@Override
public String getEndpoint() {
if (super.getEndpoint() != null) {
return super.getEndpoint();
}
return getDefaultEndpoint();
}
/** Returns the default service name. */
@Override
public String getServiceName() {
return "discoveryengine";
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return InstantiatingExecutorProvider.newBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return "discoveryengine.googleapis.com:443";
}
/** Returns the default mTLS service endpoint. */
public static String getDefaultMtlsEndpoint() {
return "discoveryengine.mtls.googleapis.com:443";
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return DEFAULT_SERVICE_SCOPES;
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return GoogleCredentialsProvider.newBuilder()
.setScopesToApply(DEFAULT_SERVICE_SCOPES)
.setUseJwtAccessWithScope(true);
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return InstantiatingGrpcChannelProvider.newBuilder()
.setMaxInboundMessageSize(Integer.MAX_VALUE);
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return InstantiatingHttpJsonChannelProvider.newBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return defaultGrpcTransportProviderBuilder().build();
}
public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder() {
return ApiClientHeaderProvider.newBuilder()
.setGeneratedLibToken(
"gapic", GaxProperties.getLibraryVersion(ConversationalSearchServiceStubSettings.class))
.setTransportToken(
GaxGrpcProperties.getGrpcTokenName(), GaxGrpcProperties.getGrpcVersion());
}
public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder() {
return ApiClientHeaderProvider.newBuilder()
.setGeneratedLibToken(
"gapic", GaxProperties.getLibraryVersion(ConversationalSearchServiceStubSettings.class))
.setTransportToken(
GaxHttpJsonProperties.getHttpJsonTokenName(),
GaxHttpJsonProperties.getHttpJsonVersion());
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return ConversationalSearchServiceStubSettings.defaultGrpcApiClientHeaderProviderBuilder();
}
/** 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 ConversationalSearchServiceStubSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
converseConversationSettings = settingsBuilder.converseConversationSettings().build();
createConversationSettings = settingsBuilder.createConversationSettings().build();
deleteConversationSettings = settingsBuilder.deleteConversationSettings().build();
updateConversationSettings = settingsBuilder.updateConversationSettings().build();
getConversationSettings = settingsBuilder.getConversationSettings().build();
listConversationsSettings = settingsBuilder.listConversationsSettings().build();
}
/** Builder for ConversationalSearchServiceStubSettings. */
public static class Builder
extends StubSettings.Builder {
private final ImmutableList> unaryMethodSettingsBuilders;
private final UnaryCallSettings.Builder<
ConverseConversationRequest, ConverseConversationResponse>
converseConversationSettings;
private final UnaryCallSettings.Builder
createConversationSettings;
private final UnaryCallSettings.Builder
deleteConversationSettings;
private final UnaryCallSettings.Builder
updateConversationSettings;
private final UnaryCallSettings.Builder
getConversationSettings;
private final PagedCallSettings.Builder<
ListConversationsRequest, ListConversationsResponse, ListConversationsPagedResponse>
listConversationsSettings;
private static final ImmutableMap>
RETRYABLE_CODE_DEFINITIONS;
static {
ImmutableMap.Builder> definitions =
ImmutableMap.builder();
definitions.put(
"retry_policy_1_codes",
ImmutableSet.copyOf(Lists.newArrayList(StatusCode.Code.UNAVAILABLE)));
RETRYABLE_CODE_DEFINITIONS = definitions.build();
}
private static final ImmutableMap RETRY_PARAM_DEFINITIONS;
static {
ImmutableMap.Builder definitions = ImmutableMap.builder();
RetrySettings settings = null;
settings =
RetrySettings.newBuilder()
.setInitialRetryDelay(Duration.ofMillis(1000L))
.setRetryDelayMultiplier(1.3)
.setMaxRetryDelay(Duration.ofMillis(10000L))
.setInitialRpcTimeout(Duration.ofMillis(30000L))
.setRpcTimeoutMultiplier(1.0)
.setMaxRpcTimeout(Duration.ofMillis(30000L))
.setTotalTimeout(Duration.ofMillis(30000L))
.build();
definitions.put("retry_policy_1_params", settings);
RETRY_PARAM_DEFINITIONS = definitions.build();
}
protected Builder() {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(clientContext);
converseConversationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
createConversationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
deleteConversationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
updateConversationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
getConversationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
listConversationsSettings = PagedCallSettings.newBuilder(LIST_CONVERSATIONS_PAGE_STR_FACT);
unaryMethodSettingsBuilders =
ImmutableList.>of(
converseConversationSettings,
createConversationSettings,
deleteConversationSettings,
updateConversationSettings,
getConversationSettings,
listConversationsSettings);
initDefaults(this);
}
protected Builder(ConversationalSearchServiceStubSettings settings) {
super(settings);
converseConversationSettings = settings.converseConversationSettings.toBuilder();
createConversationSettings = settings.createConversationSettings.toBuilder();
deleteConversationSettings = settings.deleteConversationSettings.toBuilder();
updateConversationSettings = settings.updateConversationSettings.toBuilder();
getConversationSettings = settings.getConversationSettings.toBuilder();
listConversationsSettings = settings.listConversationsSettings.toBuilder();
unaryMethodSettingsBuilders =
ImmutableList.>of(
converseConversationSettings,
createConversationSettings,
deleteConversationSettings,
updateConversationSettings,
getConversationSettings,
listConversationsSettings);
}
private static Builder createDefault() {
Builder builder = new Builder(((ClientContext) null));
builder.setTransportChannelProvider(defaultTransportChannelProvider());
builder.setCredentialsProvider(defaultCredentialsProviderBuilder().build());
builder.setInternalHeaderProvider(defaultApiClientHeaderProviderBuilder().build());
builder.setMtlsEndpoint(getDefaultMtlsEndpoint());
builder.setSwitchToMtlsEndpointAllowed(true);
return initDefaults(builder);
}
private static Builder createHttpJsonDefault() {
Builder builder = new Builder(((ClientContext) null));
builder.setTransportChannelProvider(defaultHttpJsonTransportProviderBuilder().build());
builder.setCredentialsProvider(defaultCredentialsProviderBuilder().build());
builder.setInternalHeaderProvider(defaultHttpJsonApiClientHeaderProviderBuilder().build());
builder.setMtlsEndpoint(getDefaultMtlsEndpoint());
builder.setSwitchToMtlsEndpointAllowed(true);
return initDefaults(builder);
}
private static Builder initDefaults(Builder builder) {
builder
.converseConversationSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params"));
builder
.createConversationSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params"));
builder
.deleteConversationSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params"));
builder
.updateConversationSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params"));
builder
.getConversationSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params"));
builder
.listConversationsSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params"));
return builder;
}
/**
* 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(unaryMethodSettingsBuilders, settingsUpdater);
return this;
}
public ImmutableList> unaryMethodSettingsBuilders() {
return unaryMethodSettingsBuilders;
}
/** Returns the builder for the settings used for calls to converseConversation. */
public UnaryCallSettings.Builder
converseConversationSettings() {
return converseConversationSettings;
}
/** Returns the builder for the settings used for calls to createConversation. */
public UnaryCallSettings.Builder
createConversationSettings() {
return createConversationSettings;
}
/** Returns the builder for the settings used for calls to deleteConversation. */
public UnaryCallSettings.Builder
deleteConversationSettings() {
return deleteConversationSettings;
}
/** Returns the builder for the settings used for calls to updateConversation. */
public UnaryCallSettings.Builder
updateConversationSettings() {
return updateConversationSettings;
}
/** Returns the builder for the settings used for calls to getConversation. */
public UnaryCallSettings.Builder
getConversationSettings() {
return getConversationSettings;
}
/** Returns the builder for the settings used for calls to listConversations. */
public PagedCallSettings.Builder<
ListConversationsRequest, ListConversationsResponse, ListConversationsPagedResponse>
listConversationsSettings() {
return listConversationsSettings;
}
/** Returns the endpoint set by the user or the the service's default endpoint. */
@Override
public String getEndpoint() {
if (super.getEndpoint() != null) {
return super.getEndpoint();
}
return getDefaultEndpoint();
}
@Override
public ConversationalSearchServiceStubSettings build() throws IOException {
return new ConversationalSearchServiceStubSettings(this);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy