com.google.cloud.dialogflow.v2.stub.VersionsStubSettings 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 2021 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.v2.stub;
import static com.google.cloud.dialogflow.v2.VersionsClient.ListVersionsPagedResponse;
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.v2.CreateVersionRequest;
import com.google.cloud.dialogflow.v2.DeleteVersionRequest;
import com.google.cloud.dialogflow.v2.GetVersionRequest;
import com.google.cloud.dialogflow.v2.ListVersionsRequest;
import com.google.cloud.dialogflow.v2.ListVersionsResponse;
import com.google.cloud.dialogflow.v2.UpdateVersionRequest;
import com.google.cloud.dialogflow.v2.Version;
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 VersionsStub}.
*
* 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 getVersion to 30 seconds:
*
*
{@code
* VersionsStubSettings.Builder versionsSettingsBuilder = VersionsStubSettings.newBuilder();
* versionsSettingsBuilder
* .getVersionSettings()
* .setRetrySettings(
* versionsSettingsBuilder
* .getVersionSettings()
* .getRetrySettings()
* .toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* VersionsStubSettings versionsSettings = versionsSettingsBuilder.build();
* }
*/
@Generated("by gapic-generator-java")
public class VersionsStubSettings 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<
ListVersionsRequest, ListVersionsResponse, ListVersionsPagedResponse>
listVersionsSettings;
private final UnaryCallSettings getVersionSettings;
private final UnaryCallSettings createVersionSettings;
private final UnaryCallSettings updateVersionSettings;
private final UnaryCallSettings deleteVersionSettings;
private static final PagedListDescriptor
LIST_VERSIONS_PAGE_STR_DESC =
new PagedListDescriptor() {
@Override
public String emptyToken() {
return "";
}
@Override
public ListVersionsRequest injectToken(ListVersionsRequest payload, String token) {
return ListVersionsRequest.newBuilder(payload).setPageToken(token).build();
}
@Override
public ListVersionsRequest injectPageSize(ListVersionsRequest payload, int pageSize) {
return ListVersionsRequest.newBuilder(payload).setPageSize(pageSize).build();
}
@Override
public Integer extractPageSize(ListVersionsRequest payload) {
return payload.getPageSize();
}
@Override
public String extractNextToken(ListVersionsResponse payload) {
return payload.getNextPageToken();
}
@Override
public Iterable extractResources(ListVersionsResponse payload) {
return payload.getVersionsList() == null
? ImmutableList.of()
: payload.getVersionsList();
}
};
private static final PagedListResponseFactory<
ListVersionsRequest, ListVersionsResponse, ListVersionsPagedResponse>
LIST_VERSIONS_PAGE_STR_FACT =
new PagedListResponseFactory<
ListVersionsRequest, ListVersionsResponse, ListVersionsPagedResponse>() {
@Override
public ApiFuture getFuturePagedResponse(
UnaryCallable callable,
ListVersionsRequest request,
ApiCallContext context,
ApiFuture futureResponse) {
PageContext pageContext =
PageContext.create(callable, LIST_VERSIONS_PAGE_STR_DESC, request, context);
return ListVersionsPagedResponse.createAsync(pageContext, futureResponse);
}
};
/** Returns the object with the settings used for calls to listVersions. */
public PagedCallSettings
listVersionsSettings() {
return listVersionsSettings;
}
/** Returns the object with the settings used for calls to getVersion. */
public UnaryCallSettings getVersionSettings() {
return getVersionSettings;
}
/** Returns the object with the settings used for calls to createVersion. */
public UnaryCallSettings createVersionSettings() {
return createVersionSettings;
}
/** Returns the object with the settings used for calls to updateVersion. */
public UnaryCallSettings updateVersionSettings() {
return updateVersionSettings;
}
/** Returns the object with the settings used for calls to deleteVersion. */
public UnaryCallSettings deleteVersionSettings() {
return deleteVersionSettings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public VersionsStub createStub() throws IOException {
if (getTransportChannelProvider()
.getTransportName()
.equals(GrpcTransportChannel.getGrpcTransportName())) {
return GrpcVersionsStub.create(this);
}
throw new UnsupportedOperationException(
String.format(
"Transport not supported: %s", 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 mTLS service endpoint. */
public static String getDefaultMtlsEndpoint() {
return "dialogflow.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 ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return InstantiatingGrpcChannelProvider.newBuilder()
.setMaxInboundMessageSize(Integer.MAX_VALUE);
}
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(VersionsStubSettings.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 VersionsStubSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
listVersionsSettings = settingsBuilder.listVersionsSettings().build();
getVersionSettings = settingsBuilder.getVersionSettings().build();
createVersionSettings = settingsBuilder.createVersionSettings().build();
updateVersionSettings = settingsBuilder.updateVersionSettings().build();
deleteVersionSettings = settingsBuilder.deleteVersionSettings().build();
}
/** Builder for VersionsStubSettings. */
public static class Builder extends StubSettings.Builder {
private final ImmutableList> unaryMethodSettingsBuilders;
private final PagedCallSettings.Builder<
ListVersionsRequest, ListVersionsResponse, ListVersionsPagedResponse>
listVersionsSettings;
private final UnaryCallSettings.Builder getVersionSettings;
private final UnaryCallSettings.Builder createVersionSettings;
private final UnaryCallSettings.Builder updateVersionSettings;
private final UnaryCallSettings.Builder deleteVersionSettings;
private static final ImmutableMap>
RETRYABLE_CODE_DEFINITIONS;
static {
ImmutableMap.Builder> definitions =
ImmutableMap.builder();
definitions.put(
"retry_policy_0_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(100L))
.setRetryDelayMultiplier(1.3)
.setMaxRetryDelay(Duration.ofMillis(60000L))
.setInitialRpcTimeout(Duration.ofMillis(60000L))
.setRpcTimeoutMultiplier(1.0)
.setMaxRpcTimeout(Duration.ofMillis(60000L))
.setTotalTimeout(Duration.ofMillis(60000L))
.build();
definitions.put("retry_policy_0_params", settings);
RETRY_PARAM_DEFINITIONS = definitions.build();
}
protected Builder() {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(clientContext);
listVersionsSettings = PagedCallSettings.newBuilder(LIST_VERSIONS_PAGE_STR_FACT);
getVersionSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
createVersionSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
updateVersionSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
deleteVersionSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
unaryMethodSettingsBuilders =
ImmutableList.>of(
listVersionsSettings,
getVersionSettings,
createVersionSettings,
updateVersionSettings,
deleteVersionSettings);
initDefaults(this);
}
protected Builder(VersionsStubSettings settings) {
super(settings);
listVersionsSettings = settings.listVersionsSettings.toBuilder();
getVersionSettings = settings.getVersionSettings.toBuilder();
createVersionSettings = settings.createVersionSettings.toBuilder();
updateVersionSettings = settings.updateVersionSettings.toBuilder();
deleteVersionSettings = settings.deleteVersionSettings.toBuilder();
unaryMethodSettingsBuilders =
ImmutableList.>of(
listVersionsSettings,
getVersionSettings,
createVersionSettings,
updateVersionSettings,
deleteVersionSettings);
}
private static Builder createDefault() {
Builder builder = new Builder(((ClientContext) null));
builder.setTransportChannelProvider(defaultTransportChannelProvider());
builder.setCredentialsProvider(defaultCredentialsProviderBuilder().build());
builder.setInternalHeaderProvider(defaultApiClientHeaderProviderBuilder().build());
builder.setEndpoint(getDefaultEndpoint());
builder.setMtlsEndpoint(getDefaultMtlsEndpoint());
builder.setSwitchToMtlsEndpointAllowed(true);
return initDefaults(builder);
}
private static Builder initDefaults(Builder builder) {
builder
.listVersionsSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));
builder
.getVersionSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));
builder
.createVersionSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));
builder
.updateVersionSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));
builder
.deleteVersionSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_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 listVersions. */
public PagedCallSettings.Builder<
ListVersionsRequest, ListVersionsResponse, ListVersionsPagedResponse>
listVersionsSettings() {
return listVersionsSettings;
}
/** Returns the builder for the settings used for calls to getVersion. */
public UnaryCallSettings.Builder getVersionSettings() {
return getVersionSettings;
}
/** Returns the builder for the settings used for calls to createVersion. */
public UnaryCallSettings.Builder createVersionSettings() {
return createVersionSettings;
}
/** Returns the builder for the settings used for calls to updateVersion. */
public UnaryCallSettings.Builder updateVersionSettings() {
return updateVersionSettings;
}
/** Returns the builder for the settings used for calls to deleteVersion. */
public UnaryCallSettings.Builder deleteVersionSettings() {
return deleteVersionSettings;
}
@Override
public VersionsStubSettings build() throws IOException {
return new VersionsStubSettings(this);
}
}
}