com.google.cloud.dialogflow.v2beta1.stub.DocumentsStubSettings 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.DocumentsClient.ListDocumentsPagedResponse;
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.grpc.ProtoOperationTransformers;
import com.google.api.gax.longrunning.OperationSnapshot;
import com.google.api.gax.longrunning.OperationTimedPollAlgorithm;
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.OperationCallSettings;
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.CreateDocumentRequest;
import com.google.cloud.dialogflow.v2beta1.DeleteDocumentRequest;
import com.google.cloud.dialogflow.v2beta1.Document;
import com.google.cloud.dialogflow.v2beta1.GetDocumentRequest;
import com.google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata;
import com.google.cloud.dialogflow.v2beta1.ListDocumentsRequest;
import com.google.cloud.dialogflow.v2beta1.ListDocumentsResponse;
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.longrunning.Operation;
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 DocumentsStub}.
*
* 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 getDocument to 30 seconds:
*
*
*
* DocumentsStubSettings.Builder documentsSettingsBuilder =
* DocumentsStubSettings.newBuilder();
* documentsSettingsBuilder.getDocumentSettings().getRetrySettings().toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30));
* DocumentsStubSettings documentsSettings = documentsSettingsBuilder.build();
*
*
*/
@Generated("by gapic-generator")
@BetaApi
public class DocumentsStubSettings 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 PagedCallSettings<
ListDocumentsRequest, ListDocumentsResponse, ListDocumentsPagedResponse>
listDocumentsSettings;
private final UnaryCallSettings getDocumentSettings;
private final UnaryCallSettings createDocumentSettings;
private final OperationCallSettings
createDocumentOperationSettings;
private final UnaryCallSettings deleteDocumentSettings;
private final OperationCallSettings
deleteDocumentOperationSettings;
/** Returns the object with the settings used for calls to listDocuments. */
public PagedCallSettings
listDocumentsSettings() {
return listDocumentsSettings;
}
/** Returns the object with the settings used for calls to getDocument. */
public UnaryCallSettings getDocumentSettings() {
return getDocumentSettings;
}
/** Returns the object with the settings used for calls to createDocument. */
public UnaryCallSettings createDocumentSettings() {
return createDocumentSettings;
}
/** Returns the object with the settings used for calls to createDocument. */
@BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
public OperationCallSettings
createDocumentOperationSettings() {
return createDocumentOperationSettings;
}
/** Returns the object with the settings used for calls to deleteDocument. */
public UnaryCallSettings deleteDocumentSettings() {
return deleteDocumentSettings;
}
/** Returns the object with the settings used for calls to deleteDocument. */
@BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
public OperationCallSettings
deleteDocumentOperationSettings() {
return deleteDocumentOperationSettings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public DocumentsStub createStub() throws IOException {
if (getTransportChannelProvider()
.getTransportName()
.equals(GrpcTransportChannel.getGrpcTransportName())) {
return GrpcDocumentsStub.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(DocumentsStubSettings.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 DocumentsStubSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
listDocumentsSettings = settingsBuilder.listDocumentsSettings().build();
getDocumentSettings = settingsBuilder.getDocumentSettings().build();
createDocumentSettings = settingsBuilder.createDocumentSettings().build();
createDocumentOperationSettings = settingsBuilder.createDocumentOperationSettings().build();
deleteDocumentSettings = settingsBuilder.deleteDocumentSettings().build();
deleteDocumentOperationSettings = settingsBuilder.deleteDocumentOperationSettings().build();
}
private static final PagedListDescriptor
LIST_DOCUMENTS_PAGE_STR_DESC =
new PagedListDescriptor() {
@Override
public String emptyToken() {
return "";
}
@Override
public ListDocumentsRequest injectToken(ListDocumentsRequest payload, String token) {
return ListDocumentsRequest.newBuilder(payload).setPageToken(token).build();
}
@Override
public ListDocumentsRequest injectPageSize(ListDocumentsRequest payload, int pageSize) {
return ListDocumentsRequest.newBuilder(payload).setPageSize(pageSize).build();
}
@Override
public Integer extractPageSize(ListDocumentsRequest payload) {
return payload.getPageSize();
}
@Override
public String extractNextToken(ListDocumentsResponse payload) {
return payload.getNextPageToken();
}
@Override
public Iterable extractResources(ListDocumentsResponse payload) {
return payload.getDocumentsList() != null
? payload.getDocumentsList()
: ImmutableList.of();
}
};
private static final PagedListResponseFactory<
ListDocumentsRequest, ListDocumentsResponse, ListDocumentsPagedResponse>
LIST_DOCUMENTS_PAGE_STR_FACT =
new PagedListResponseFactory<
ListDocumentsRequest, ListDocumentsResponse, ListDocumentsPagedResponse>() {
@Override
public ApiFuture getFuturePagedResponse(
UnaryCallable callable,
ListDocumentsRequest request,
ApiCallContext context,
ApiFuture futureResponse) {
PageContext pageContext =
PageContext.create(callable, LIST_DOCUMENTS_PAGE_STR_DESC, request, context);
return ListDocumentsPagedResponse.createAsync(pageContext, futureResponse);
}
};
/** Builder for DocumentsStubSettings. */
public static class Builder extends StubSettings.Builder {
private final ImmutableList> unaryMethodSettingsBuilders;
private final PagedCallSettings.Builder<
ListDocumentsRequest, ListDocumentsResponse, ListDocumentsPagedResponse>
listDocumentsSettings;
private final UnaryCallSettings.Builder getDocumentSettings;
private final UnaryCallSettings.Builder
createDocumentSettings;
private final OperationCallSettings.Builder<
CreateDocumentRequest, Document, KnowledgeOperationMetadata>
createDocumentOperationSettings;
private final UnaryCallSettings.Builder
deleteDocumentSettings;
private final OperationCallSettings.Builder<
DeleteDocumentRequest, Empty, KnowledgeOperationMetadata>
deleteDocumentOperationSettings;
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);
listDocumentsSettings = PagedCallSettings.newBuilder(LIST_DOCUMENTS_PAGE_STR_FACT);
getDocumentSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
createDocumentSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
createDocumentOperationSettings = OperationCallSettings.newBuilder();
deleteDocumentSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
deleteDocumentOperationSettings = OperationCallSettings.newBuilder();
unaryMethodSettingsBuilders =
ImmutableList.>of(
listDocumentsSettings,
getDocumentSettings,
createDocumentSettings,
deleteDocumentSettings);
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
.listDocumentsSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.getDocumentSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.createDocumentSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("non_idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.deleteDocumentSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.createDocumentOperationSettings()
.setInitialCallSettings(
UnaryCallSettings
.newUnaryCallSettingsBuilder()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"))
.build())
.setResponseTransformer(
ProtoOperationTransformers.ResponseTransformer.create(Document.class))
.setMetadataTransformer(
ProtoOperationTransformers.MetadataTransformer.create(
KnowledgeOperationMetadata.class))
.setPollingAlgorithm(
OperationTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelay(Duration.ofMillis(500L))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelay(Duration.ofMillis(5000L))
.setInitialRpcTimeout(Duration.ZERO) // ignored
.setRpcTimeoutMultiplier(1.0) // ignored
.setMaxRpcTimeout(Duration.ZERO) // ignored
.setTotalTimeout(Duration.ofMillis(300000L))
.build()));
builder
.deleteDocumentOperationSettings()
.setInitialCallSettings(
UnaryCallSettings
.newUnaryCallSettingsBuilder()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"))
.build())
.setResponseTransformer(
ProtoOperationTransformers.ResponseTransformer.create(Empty.class))
.setMetadataTransformer(
ProtoOperationTransformers.MetadataTransformer.create(
KnowledgeOperationMetadata.class))
.setPollingAlgorithm(
OperationTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelay(Duration.ofMillis(500L))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelay(Duration.ofMillis(5000L))
.setInitialRpcTimeout(Duration.ZERO) // ignored
.setRpcTimeoutMultiplier(1.0) // ignored
.setMaxRpcTimeout(Duration.ZERO) // ignored
.setTotalTimeout(Duration.ofMillis(300000L))
.build()));
return builder;
}
protected Builder(DocumentsStubSettings settings) {
super(settings);
listDocumentsSettings = settings.listDocumentsSettings.toBuilder();
getDocumentSettings = settings.getDocumentSettings.toBuilder();
createDocumentSettings = settings.createDocumentSettings.toBuilder();
createDocumentOperationSettings = settings.createDocumentOperationSettings.toBuilder();
deleteDocumentSettings = settings.deleteDocumentSettings.toBuilder();
deleteDocumentOperationSettings = settings.deleteDocumentOperationSettings.toBuilder();
unaryMethodSettingsBuilders =
ImmutableList.>of(
listDocumentsSettings,
getDocumentSettings,
createDocumentSettings,
deleteDocumentSettings);
}
// 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 listDocuments. */
public PagedCallSettings.Builder<
ListDocumentsRequest, ListDocumentsResponse, ListDocumentsPagedResponse>
listDocumentsSettings() {
return listDocumentsSettings;
}
/** Returns the builder for the settings used for calls to getDocument. */
public UnaryCallSettings.Builder getDocumentSettings() {
return getDocumentSettings;
}
/** Returns the builder for the settings used for calls to createDocument. */
public UnaryCallSettings.Builder createDocumentSettings() {
return createDocumentSettings;
}
/** Returns the builder for the settings used for calls to createDocument. */
@BetaApi(
"The surface for use by generated code is not stable yet and may change in the future.")
public OperationCallSettings.Builder<
CreateDocumentRequest, Document, KnowledgeOperationMetadata>
createDocumentOperationSettings() {
return createDocumentOperationSettings;
}
/** Returns the builder for the settings used for calls to deleteDocument. */
public UnaryCallSettings.Builder deleteDocumentSettings() {
return deleteDocumentSettings;
}
/** Returns the builder for the settings used for calls to deleteDocument. */
@BetaApi(
"The surface for use by generated code is not stable yet and may change in the future.")
public OperationCallSettings.Builder
deleteDocumentOperationSettings() {
return deleteDocumentOperationSettings;
}
@Override
public DocumentsStubSettings build() throws IOException {
return new DocumentsStubSettings(this);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy