com.google.cloud.dialogflow.v2beta1.stub.IntentsStubSettings 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.IntentsClient.ListIntentsPagedResponse;
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.BatchDeleteIntentsRequest;
import com.google.cloud.dialogflow.v2beta1.BatchUpdateIntentsRequest;
import com.google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse;
import com.google.cloud.dialogflow.v2beta1.CreateIntentRequest;
import com.google.cloud.dialogflow.v2beta1.DeleteIntentRequest;
import com.google.cloud.dialogflow.v2beta1.GetIntentRequest;
import com.google.cloud.dialogflow.v2beta1.Intent;
import com.google.cloud.dialogflow.v2beta1.ListIntentsRequest;
import com.google.cloud.dialogflow.v2beta1.ListIntentsResponse;
import com.google.cloud.dialogflow.v2beta1.UpdateIntentRequest;
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 com.google.protobuf.Struct;
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 IntentsStub}.
*
* 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 getIntent to 30 seconds:
*
*
*
* IntentsStubSettings.Builder intentsSettingsBuilder =
* IntentsStubSettings.newBuilder();
* intentsSettingsBuilder.getIntentSettings().getRetrySettings().toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30));
* IntentsStubSettings intentsSettings = intentsSettingsBuilder.build();
*
*
*/
@Generated("by gapic-generator")
@BetaApi
public class IntentsStubSettings 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
listIntentsSettings;
private final UnaryCallSettings getIntentSettings;
private final UnaryCallSettings createIntentSettings;
private final UnaryCallSettings updateIntentSettings;
private final UnaryCallSettings deleteIntentSettings;
private final UnaryCallSettings batchUpdateIntentsSettings;
private final OperationCallSettings
batchUpdateIntentsOperationSettings;
private final UnaryCallSettings batchDeleteIntentsSettings;
private final OperationCallSettings
batchDeleteIntentsOperationSettings;
/** Returns the object with the settings used for calls to listIntents. */
public PagedCallSettings
listIntentsSettings() {
return listIntentsSettings;
}
/** Returns the object with the settings used for calls to getIntent. */
public UnaryCallSettings getIntentSettings() {
return getIntentSettings;
}
/** Returns the object with the settings used for calls to createIntent. */
public UnaryCallSettings createIntentSettings() {
return createIntentSettings;
}
/** Returns the object with the settings used for calls to updateIntent. */
public UnaryCallSettings updateIntentSettings() {
return updateIntentSettings;
}
/** Returns the object with the settings used for calls to deleteIntent. */
public UnaryCallSettings deleteIntentSettings() {
return deleteIntentSettings;
}
/** Returns the object with the settings used for calls to batchUpdateIntents. */
public UnaryCallSettings batchUpdateIntentsSettings() {
return batchUpdateIntentsSettings;
}
/** Returns the object with the settings used for calls to batchUpdateIntents. */
@BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
public OperationCallSettings
batchUpdateIntentsOperationSettings() {
return batchUpdateIntentsOperationSettings;
}
/** Returns the object with the settings used for calls to batchDeleteIntents. */
public UnaryCallSettings batchDeleteIntentsSettings() {
return batchDeleteIntentsSettings;
}
/** Returns the object with the settings used for calls to batchDeleteIntents. */
@BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
public OperationCallSettings
batchDeleteIntentsOperationSettings() {
return batchDeleteIntentsOperationSettings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public IntentsStub createStub() throws IOException {
if (getTransportChannelProvider()
.getTransportName()
.equals(GrpcTransportChannel.getGrpcTransportName())) {
return GrpcIntentsStub.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(IntentsStubSettings.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 IntentsStubSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
listIntentsSettings = settingsBuilder.listIntentsSettings().build();
getIntentSettings = settingsBuilder.getIntentSettings().build();
createIntentSettings = settingsBuilder.createIntentSettings().build();
updateIntentSettings = settingsBuilder.updateIntentSettings().build();
deleteIntentSettings = settingsBuilder.deleteIntentSettings().build();
batchUpdateIntentsSettings = settingsBuilder.batchUpdateIntentsSettings().build();
batchUpdateIntentsOperationSettings =
settingsBuilder.batchUpdateIntentsOperationSettings().build();
batchDeleteIntentsSettings = settingsBuilder.batchDeleteIntentsSettings().build();
batchDeleteIntentsOperationSettings =
settingsBuilder.batchDeleteIntentsOperationSettings().build();
}
private static final PagedListDescriptor
LIST_INTENTS_PAGE_STR_DESC =
new PagedListDescriptor() {
@Override
public String emptyToken() {
return "";
}
@Override
public ListIntentsRequest injectToken(ListIntentsRequest payload, String token) {
return ListIntentsRequest.newBuilder(payload).setPageToken(token).build();
}
@Override
public ListIntentsRequest injectPageSize(ListIntentsRequest payload, int pageSize) {
return ListIntentsRequest.newBuilder(payload).setPageSize(pageSize).build();
}
@Override
public Integer extractPageSize(ListIntentsRequest payload) {
return payload.getPageSize();
}
@Override
public String extractNextToken(ListIntentsResponse payload) {
return payload.getNextPageToken();
}
@Override
public Iterable extractResources(ListIntentsResponse payload) {
return payload.getIntentsList() != null
? payload.getIntentsList()
: ImmutableList.of();
}
};
private static final PagedListResponseFactory<
ListIntentsRequest, ListIntentsResponse, ListIntentsPagedResponse>
LIST_INTENTS_PAGE_STR_FACT =
new PagedListResponseFactory<
ListIntentsRequest, ListIntentsResponse, ListIntentsPagedResponse>() {
@Override
public ApiFuture getFuturePagedResponse(
UnaryCallable callable,
ListIntentsRequest request,
ApiCallContext context,
ApiFuture futureResponse) {
PageContext pageContext =
PageContext.create(callable, LIST_INTENTS_PAGE_STR_DESC, request, context);
return ListIntentsPagedResponse.createAsync(pageContext, futureResponse);
}
};
/** Builder for IntentsStubSettings. */
public static class Builder extends StubSettings.Builder {
private final ImmutableList> unaryMethodSettingsBuilders;
private final PagedCallSettings.Builder<
ListIntentsRequest, ListIntentsResponse, ListIntentsPagedResponse>
listIntentsSettings;
private final UnaryCallSettings.Builder getIntentSettings;
private final UnaryCallSettings.Builder createIntentSettings;
private final UnaryCallSettings.Builder updateIntentSettings;
private final UnaryCallSettings.Builder deleteIntentSettings;
private final UnaryCallSettings.Builder
batchUpdateIntentsSettings;
private final OperationCallSettings.Builder<
BatchUpdateIntentsRequest, BatchUpdateIntentsResponse, Struct>
batchUpdateIntentsOperationSettings;
private final UnaryCallSettings.Builder
batchDeleteIntentsSettings;
private final OperationCallSettings.Builder
batchDeleteIntentsOperationSettings;
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);
listIntentsSettings = PagedCallSettings.newBuilder(LIST_INTENTS_PAGE_STR_FACT);
getIntentSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
createIntentSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
updateIntentSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
deleteIntentSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
batchUpdateIntentsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
batchUpdateIntentsOperationSettings = OperationCallSettings.newBuilder();
batchDeleteIntentsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
batchDeleteIntentsOperationSettings = OperationCallSettings.newBuilder();
unaryMethodSettingsBuilders =
ImmutableList.>of(
listIntentsSettings,
getIntentSettings,
createIntentSettings,
updateIntentSettings,
deleteIntentSettings,
batchUpdateIntentsSettings,
batchDeleteIntentsSettings);
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
.listIntentsSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.getIntentSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.createIntentSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("non_idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.updateIntentSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("non_idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.deleteIntentSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.batchUpdateIntentsSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("non_idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.batchDeleteIntentsSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.batchUpdateIntentsOperationSettings()
.setInitialCallSettings(
UnaryCallSettings
.newUnaryCallSettingsBuilder()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"))
.build())
.setResponseTransformer(
ProtoOperationTransformers.ResponseTransformer.create(
BatchUpdateIntentsResponse.class))
.setMetadataTransformer(
ProtoOperationTransformers.MetadataTransformer.create(Struct.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
.batchDeleteIntentsOperationSettings()
.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(Struct.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(IntentsStubSettings settings) {
super(settings);
listIntentsSettings = settings.listIntentsSettings.toBuilder();
getIntentSettings = settings.getIntentSettings.toBuilder();
createIntentSettings = settings.createIntentSettings.toBuilder();
updateIntentSettings = settings.updateIntentSettings.toBuilder();
deleteIntentSettings = settings.deleteIntentSettings.toBuilder();
batchUpdateIntentsSettings = settings.batchUpdateIntentsSettings.toBuilder();
batchUpdateIntentsOperationSettings =
settings.batchUpdateIntentsOperationSettings.toBuilder();
batchDeleteIntentsSettings = settings.batchDeleteIntentsSettings.toBuilder();
batchDeleteIntentsOperationSettings =
settings.batchDeleteIntentsOperationSettings.toBuilder();
unaryMethodSettingsBuilders =
ImmutableList.>of(
listIntentsSettings,
getIntentSettings,
createIntentSettings,
updateIntentSettings,
deleteIntentSettings,
batchUpdateIntentsSettings,
batchDeleteIntentsSettings);
}
// 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 listIntents. */
public PagedCallSettings.Builder<
ListIntentsRequest, ListIntentsResponse, ListIntentsPagedResponse>
listIntentsSettings() {
return listIntentsSettings;
}
/** Returns the builder for the settings used for calls to getIntent. */
public UnaryCallSettings.Builder getIntentSettings() {
return getIntentSettings;
}
/** Returns the builder for the settings used for calls to createIntent. */
public UnaryCallSettings.Builder createIntentSettings() {
return createIntentSettings;
}
/** Returns the builder for the settings used for calls to updateIntent. */
public UnaryCallSettings.Builder updateIntentSettings() {
return updateIntentSettings;
}
/** Returns the builder for the settings used for calls to deleteIntent. */
public UnaryCallSettings.Builder deleteIntentSettings() {
return deleteIntentSettings;
}
/** Returns the builder for the settings used for calls to batchUpdateIntents. */
public UnaryCallSettings.Builder
batchUpdateIntentsSettings() {
return batchUpdateIntentsSettings;
}
/** Returns the builder for the settings used for calls to batchUpdateIntents. */
@BetaApi(
"The surface for use by generated code is not stable yet and may change in the future.")
public OperationCallSettings.Builder<
BatchUpdateIntentsRequest, BatchUpdateIntentsResponse, Struct>
batchUpdateIntentsOperationSettings() {
return batchUpdateIntentsOperationSettings;
}
/** Returns the builder for the settings used for calls to batchDeleteIntents. */
public UnaryCallSettings.Builder
batchDeleteIntentsSettings() {
return batchDeleteIntentsSettings;
}
/** Returns the builder for the settings used for calls to batchDeleteIntents. */
@BetaApi(
"The surface for use by generated code is not stable yet and may change in the future.")
public OperationCallSettings.Builder
batchDeleteIntentsOperationSettings() {
return batchDeleteIntentsOperationSettings;
}
@Override
public IntentsStubSettings build() throws IOException {
return new IntentsStubSettings(this);
}
}
}