com.google.cloud.dialogflow.v2.ContextsSettings Maven / Gradle / Ivy
Show all versions of google-cloud-dialogflow Show documentation
/*
* 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;
import static com.google.cloud.dialogflow.v2.ContextsClient.ListContextsPagedResponse;
import com.google.api.core.ApiFunction;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.ClientSettings;
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.cloud.dialogflow.v2.stub.ContextsStubSettings;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Settings class to configure an instance of {@link ContextsClient}.
*
* 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 getContext to 30 seconds:
*
*
{@code
* ContextsSettings.Builder contextsSettingsBuilder = ContextsSettings.newBuilder();
* contextsSettingsBuilder
* .getContextSettings()
* .setRetrySettings(
* contextsSettingsBuilder
* .getContextSettings()
* .getRetrySettings()
* .toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* ContextsSettings contextsSettings = contextsSettingsBuilder.build();
* }
*/
@Generated("by gapic-generator-java")
public class ContextsSettings extends ClientSettings {
/** Returns the object with the settings used for calls to listContexts. */
public PagedCallSettings
listContextsSettings() {
return ((ContextsStubSettings) getStubSettings()).listContextsSettings();
}
/** Returns the object with the settings used for calls to getContext. */
public UnaryCallSettings getContextSettings() {
return ((ContextsStubSettings) getStubSettings()).getContextSettings();
}
/** Returns the object with the settings used for calls to createContext. */
public UnaryCallSettings createContextSettings() {
return ((ContextsStubSettings) getStubSettings()).createContextSettings();
}
/** Returns the object with the settings used for calls to updateContext. */
public UnaryCallSettings updateContextSettings() {
return ((ContextsStubSettings) getStubSettings()).updateContextSettings();
}
/** Returns the object with the settings used for calls to deleteContext. */
public UnaryCallSettings deleteContextSettings() {
return ((ContextsStubSettings) getStubSettings()).deleteContextSettings();
}
/** Returns the object with the settings used for calls to deleteAllContexts. */
public UnaryCallSettings deleteAllContextsSettings() {
return ((ContextsStubSettings) getStubSettings()).deleteAllContextsSettings();
}
public static final ContextsSettings create(ContextsStubSettings stub) throws IOException {
return new ContextsSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return ContextsStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return ContextsStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return ContextsStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return ContextsStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return ContextsStubSettings.defaultGrpcTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return ContextsStubSettings.defaultTransportChannelProvider();
}
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return ContextsStubSettings.defaultApiClientHeaderProviderBuilder();
}
/** 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 ContextsSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for ContextsSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(ContextsStubSettings.newBuilder(clientContext));
}
protected Builder(ContextsSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(ContextsStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(ContextsStubSettings.newBuilder());
}
public ContextsStubSettings.Builder getStubSettingsBuilder() {
return ((ContextsStubSettings.Builder) getStubSettings());
}
/**
* 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(
getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
return this;
}
/** Returns the builder for the settings used for calls to listContexts. */
public PagedCallSettings.Builder<
ListContextsRequest, ListContextsResponse, ListContextsPagedResponse>
listContextsSettings() {
return getStubSettingsBuilder().listContextsSettings();
}
/** Returns the builder for the settings used for calls to getContext. */
public UnaryCallSettings.Builder getContextSettings() {
return getStubSettingsBuilder().getContextSettings();
}
/** Returns the builder for the settings used for calls to createContext. */
public UnaryCallSettings.Builder createContextSettings() {
return getStubSettingsBuilder().createContextSettings();
}
/** Returns the builder for the settings used for calls to updateContext. */
public UnaryCallSettings.Builder updateContextSettings() {
return getStubSettingsBuilder().updateContextSettings();
}
/** Returns the builder for the settings used for calls to deleteContext. */
public UnaryCallSettings.Builder deleteContextSettings() {
return getStubSettingsBuilder().deleteContextSettings();
}
/** Returns the builder for the settings used for calls to deleteAllContexts. */
public UnaryCallSettings.Builder deleteAllContextsSettings() {
return getStubSettingsBuilder().deleteAllContextsSettings();
}
@Override
public ContextsSettings build() throws IOException {
return new ContextsSettings(this);
}
}
}