com.google.cloud.dialogflow.v2beta1.stub.KnowledgeBasesStubSettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-dialogflow Show documentation
Show all versions of google-cloud-dialogflow Show documentation
Java idiomatic client for Google Cloud Dialog Flow API
/*
* Copyright 2019 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.dialogflow.v2beta1.stub;
import static com.google.cloud.dialogflow.v2beta1.KnowledgeBasesClient.ListKnowledgeBasesPagedResponse;
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.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.dialogflow.v2beta1.CreateKnowledgeBaseRequest;
import com.google.cloud.dialogflow.v2beta1.DeleteKnowledgeBaseRequest;
import com.google.cloud.dialogflow.v2beta1.GetKnowledgeBaseRequest;
import com.google.cloud.dialogflow.v2beta1.KnowledgeBase;
import com.google.cloud.dialogflow.v2beta1.ListKnowledgeBasesRequest;
import com.google.cloud.dialogflow.v2beta1.ListKnowledgeBasesResponse;
import com.google.cloud.dialogflow.v2beta1.UpdateKnowledgeBaseRequest;
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 KnowledgeBasesStub}.
*
* The default instance has everything set to sensible defaults:
*
*
* - The default service address (dialogflow.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 getKnowledgeBase to 30 seconds:
*
*
*
* KnowledgeBasesStubSettings.Builder knowledgeBasesSettingsBuilder =
* KnowledgeBasesStubSettings.newBuilder();
* knowledgeBasesSettingsBuilder.getKnowledgeBaseSettings().getRetrySettings().toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30));
* KnowledgeBasesStubSettings knowledgeBasesSettings = knowledgeBasesSettingsBuilder.build();
*
*
*/
@Generated("by gapic-generator")
@BetaApi
public class KnowledgeBasesStubSettings 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")
.add("https://www.googleapis.com/auth/dialogflow")
.build();
private final PagedCallSettings<
ListKnowledgeBasesRequest, ListKnowledgeBasesResponse, ListKnowledgeBasesPagedResponse>
listKnowledgeBasesSettings;
private final UnaryCallSettings getKnowledgeBaseSettings;
private final UnaryCallSettings
createKnowledgeBaseSettings;
private final UnaryCallSettings deleteKnowledgeBaseSettings;
private final UnaryCallSettings
updateKnowledgeBaseSettings;
/** Returns the object with the settings used for calls to listKnowledgeBases. */
public PagedCallSettings<
ListKnowledgeBasesRequest, ListKnowledgeBasesResponse, ListKnowledgeBasesPagedResponse>
listKnowledgeBasesSettings() {
return listKnowledgeBasesSettings;
}
/** Returns the object with the settings used for calls to getKnowledgeBase. */
public UnaryCallSettings getKnowledgeBaseSettings() {
return getKnowledgeBaseSettings;
}
/** Returns the object with the settings used for calls to createKnowledgeBase. */
public UnaryCallSettings
createKnowledgeBaseSettings() {
return createKnowledgeBaseSettings;
}
/** Returns the object with the settings used for calls to deleteKnowledgeBase. */
public UnaryCallSettings deleteKnowledgeBaseSettings() {
return deleteKnowledgeBaseSettings;
}
/** Returns the object with the settings used for calls to updateKnowledgeBase. */
public UnaryCallSettings
updateKnowledgeBaseSettings() {
return updateKnowledgeBaseSettings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public KnowledgeBasesStub createStub() throws IOException {
if (getTransportChannelProvider()
.getTransportName()
.equals(GrpcTransportChannel.getGrpcTransportName())) {
return GrpcKnowledgeBasesStub.create(this);
} else {
throw new UnsupportedOperationException(
"Transport not supported: " + getTransportChannelProvider().getTransportName());
}
}
/** 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 "dialogflow.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);
}
/** Returns a builder for the default ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return InstantiatingGrpcChannelProvider.newBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return defaultGrpcTransportProviderBuilder().build();
}
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return ApiClientHeaderProvider.newBuilder()
.setGeneratedLibToken(
"gapic", GaxProperties.getLibraryVersion(KnowledgeBasesStubSettings.class))
.setTransportToken(
GaxGrpcProperties.getGrpcTokenName(), GaxGrpcProperties.getGrpcVersion());
}
/** Returns a new builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** 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 KnowledgeBasesStubSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
listKnowledgeBasesSettings = settingsBuilder.listKnowledgeBasesSettings().build();
getKnowledgeBaseSettings = settingsBuilder.getKnowledgeBaseSettings().build();
createKnowledgeBaseSettings = settingsBuilder.createKnowledgeBaseSettings().build();
deleteKnowledgeBaseSettings = settingsBuilder.deleteKnowledgeBaseSettings().build();
updateKnowledgeBaseSettings = settingsBuilder.updateKnowledgeBaseSettings().build();
}
private static final PagedListDescriptor<
ListKnowledgeBasesRequest, ListKnowledgeBasesResponse, KnowledgeBase>
LIST_KNOWLEDGE_BASES_PAGE_STR_DESC =
new PagedListDescriptor<
ListKnowledgeBasesRequest, ListKnowledgeBasesResponse, KnowledgeBase>() {
@Override
public String emptyToken() {
return "";
}
@Override
public ListKnowledgeBasesRequest injectToken(
ListKnowledgeBasesRequest payload, String token) {
return ListKnowledgeBasesRequest.newBuilder(payload).setPageToken(token).build();
}
@Override
public ListKnowledgeBasesRequest injectPageSize(
ListKnowledgeBasesRequest payload, int pageSize) {
return ListKnowledgeBasesRequest.newBuilder(payload).setPageSize(pageSize).build();
}
@Override
public Integer extractPageSize(ListKnowledgeBasesRequest payload) {
return payload.getPageSize();
}
@Override
public String extractNextToken(ListKnowledgeBasesResponse payload) {
return payload.getNextPageToken();
}
@Override
public Iterable extractResources(ListKnowledgeBasesResponse payload) {
return payload.getKnowledgeBasesList() != null
? payload.getKnowledgeBasesList()
: ImmutableList.of();
}
};
private static final PagedListResponseFactory<
ListKnowledgeBasesRequest, ListKnowledgeBasesResponse, ListKnowledgeBasesPagedResponse>
LIST_KNOWLEDGE_BASES_PAGE_STR_FACT =
new PagedListResponseFactory<
ListKnowledgeBasesRequest,
ListKnowledgeBasesResponse,
ListKnowledgeBasesPagedResponse>() {
@Override
public ApiFuture getFuturePagedResponse(
UnaryCallable callable,
ListKnowledgeBasesRequest request,
ApiCallContext context,
ApiFuture futureResponse) {
PageContext
pageContext =
PageContext.create(
callable, LIST_KNOWLEDGE_BASES_PAGE_STR_DESC, request, context);
return ListKnowledgeBasesPagedResponse.createAsync(pageContext, futureResponse);
}
};
/** Builder for KnowledgeBasesStubSettings. */
public static class Builder extends StubSettings.Builder {
private final ImmutableList> unaryMethodSettingsBuilders;
private final PagedCallSettings.Builder<
ListKnowledgeBasesRequest, ListKnowledgeBasesResponse, ListKnowledgeBasesPagedResponse>
listKnowledgeBasesSettings;
private final UnaryCallSettings.Builder
getKnowledgeBaseSettings;
private final UnaryCallSettings.Builder
createKnowledgeBaseSettings;
private final UnaryCallSettings.Builder
deleteKnowledgeBaseSettings;
private final UnaryCallSettings.Builder
updateKnowledgeBaseSettings;
private static final ImmutableMap>
RETRYABLE_CODE_DEFINITIONS;
static {
ImmutableMap.Builder> definitions =
ImmutableMap.builder();
definitions.put(
"idempotent",
ImmutableSet.copyOf(
Lists.newArrayList(
StatusCode.Code.DEADLINE_EXCEEDED, StatusCode.Code.UNAVAILABLE)));
definitions.put("non_idempotent", ImmutableSet.copyOf(Lists.newArrayList()));
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(100L))
.setRetryDelayMultiplier(1.3)
.setMaxRetryDelay(Duration.ofMillis(60000L))
.setInitialRpcTimeout(Duration.ofMillis(20000L))
.setRpcTimeoutMultiplier(1.0)
.setMaxRpcTimeout(Duration.ofMillis(20000L))
.setTotalTimeout(Duration.ofMillis(600000L))
.build();
definitions.put("default", settings);
RETRY_PARAM_DEFINITIONS = definitions.build();
}
protected Builder() {
this((ClientContext) null);
}
protected Builder(ClientContext clientContext) {
super(clientContext);
listKnowledgeBasesSettings = PagedCallSettings.newBuilder(LIST_KNOWLEDGE_BASES_PAGE_STR_FACT);
getKnowledgeBaseSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
createKnowledgeBaseSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
deleteKnowledgeBaseSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
updateKnowledgeBaseSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
unaryMethodSettingsBuilders =
ImmutableList.>of(
listKnowledgeBasesSettings,
getKnowledgeBaseSettings,
createKnowledgeBaseSettings,
deleteKnowledgeBaseSettings,
updateKnowledgeBaseSettings);
initDefaults(this);
}
private static Builder createDefault() {
Builder builder = new Builder((ClientContext) null);
builder.setTransportChannelProvider(defaultTransportChannelProvider());
builder.setCredentialsProvider(defaultCredentialsProviderBuilder().build());
builder.setInternalHeaderProvider(defaultApiClientHeaderProviderBuilder().build());
builder.setEndpoint(getDefaultEndpoint());
return initDefaults(builder);
}
private static Builder initDefaults(Builder builder) {
builder
.listKnowledgeBasesSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.getKnowledgeBaseSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.createKnowledgeBaseSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("non_idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.deleteKnowledgeBaseSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.updateKnowledgeBaseSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("non_idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
return builder;
}
protected Builder(KnowledgeBasesStubSettings settings) {
super(settings);
listKnowledgeBasesSettings = settings.listKnowledgeBasesSettings.toBuilder();
getKnowledgeBaseSettings = settings.getKnowledgeBaseSettings.toBuilder();
createKnowledgeBaseSettings = settings.createKnowledgeBaseSettings.toBuilder();
deleteKnowledgeBaseSettings = settings.deleteKnowledgeBaseSettings.toBuilder();
updateKnowledgeBaseSettings = settings.updateKnowledgeBaseSettings.toBuilder();
unaryMethodSettingsBuilders =
ImmutableList.>of(
listKnowledgeBasesSettings,
getKnowledgeBaseSettings,
createKnowledgeBaseSettings,
deleteKnowledgeBaseSettings,
updateKnowledgeBaseSettings);
}
// NEXT_MAJOR_VER: remove 'throws Exception'
/**
* 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) throws Exception {
super.applyToAllUnaryMethods(unaryMethodSettingsBuilders, settingsUpdater);
return this;
}
public ImmutableList> unaryMethodSettingsBuilders() {
return unaryMethodSettingsBuilders;
}
/** Returns the builder for the settings used for calls to listKnowledgeBases. */
public PagedCallSettings.Builder<
ListKnowledgeBasesRequest, ListKnowledgeBasesResponse, ListKnowledgeBasesPagedResponse>
listKnowledgeBasesSettings() {
return listKnowledgeBasesSettings;
}
/** Returns the builder for the settings used for calls to getKnowledgeBase. */
public UnaryCallSettings.Builder
getKnowledgeBaseSettings() {
return getKnowledgeBaseSettings;
}
/** Returns the builder for the settings used for calls to createKnowledgeBase. */
public UnaryCallSettings.Builder
createKnowledgeBaseSettings() {
return createKnowledgeBaseSettings;
}
/** Returns the builder for the settings used for calls to deleteKnowledgeBase. */
public UnaryCallSettings.Builder
deleteKnowledgeBaseSettings() {
return deleteKnowledgeBaseSettings;
}
/** Returns the builder for the settings used for calls to updateKnowledgeBase. */
public UnaryCallSettings.Builder
updateKnowledgeBaseSettings() {
return updateKnowledgeBaseSettings;
}
@Override
public KnowledgeBasesStubSettings build() throws IOException {
return new KnowledgeBasesStubSettings(this);
}
}
}