com.google.cloud.dialogflow.v2

Class KnowledgeBasesSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<KnowledgeBasesSettings>

com.google.cloud.dialogflow.v2.KnowledgeBasesSettings

@Generated(value="by gapic-generator-java")
public class KnowledgeBasesSettings
extends ClientSettings<KnowledgeBasesSettings>

Settings class to configure an instance of KnowledgeBasesClient.

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:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 KnowledgeBasesSettings.Builder knowledgeBasesSettingsBuilder =
     KnowledgeBasesSettings.newBuilder();
 knowledgeBasesSettingsBuilder
     .getKnowledgeBaseSettings()
     .setRetrySettings(
         knowledgeBasesSettingsBuilder.getKnowledgeBaseSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 KnowledgeBasesSettings knowledgeBasesSettings = knowledgeBasesSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KnowledgeBasesSettings.Builder Builder for KnowledgeBasesSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KnowledgeBasesSettings(KnowledgeBasesSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static KnowledgeBasesSettings	create(KnowledgeBasesStubSettings stub)
UnaryCallSettings<CreateKnowledgeBaseRequest,KnowledgeBase>	createKnowledgeBaseSettings() Returns the object with the settings used for calls to createKnowledgeBase.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<DeleteKnowledgeBaseRequest,Empty>	deleteKnowledgeBaseSettings() Returns the object with the settings used for calls to deleteKnowledgeBase.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<GetKnowledgeBaseRequest,KnowledgeBase>	getKnowledgeBaseSettings() Returns the object with the settings used for calls to getKnowledgeBase.
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationSettings() Returns the object with the settings used for calls to getLocation.
PagedCallSettings<ListKnowledgeBasesRequest,ListKnowledgeBasesResponse,KnowledgeBasesClient.ListKnowledgeBasesPagedResponse>	listKnowledgeBasesSettings() Returns the object with the settings used for calls to listKnowledgeBases.
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,KnowledgeBasesClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
static KnowledgeBasesSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static KnowledgeBasesSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
static KnowledgeBasesSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
KnowledgeBasesSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<UpdateKnowledgeBaseRequest,KnowledgeBase>	updateKnowledgeBaseSettings() Returns the object with the settings used for calls to updateKnowledgeBase.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

KnowledgeBasesSettings

protected KnowledgeBasesSettings(KnowledgeBasesSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

listKnowledgeBasesSettings

public PagedCallSettings<ListKnowledgeBasesRequest,ListKnowledgeBasesResponse,KnowledgeBasesClient.ListKnowledgeBasesPagedResponse> listKnowledgeBasesSettings()

Returns the object with the settings used for calls to listKnowledgeBases.

getKnowledgeBaseSettings

public UnaryCallSettings<GetKnowledgeBaseRequest,KnowledgeBase> getKnowledgeBaseSettings()

Returns the object with the settings used for calls to getKnowledgeBase.

createKnowledgeBaseSettings

public UnaryCallSettings<CreateKnowledgeBaseRequest,KnowledgeBase> createKnowledgeBaseSettings()

Returns the object with the settings used for calls to createKnowledgeBase.

deleteKnowledgeBaseSettings

public UnaryCallSettings<DeleteKnowledgeBaseRequest,Empty> deleteKnowledgeBaseSettings()

Returns the object with the settings used for calls to deleteKnowledgeBase.

updateKnowledgeBaseSettings

public UnaryCallSettings<UpdateKnowledgeBaseRequest,KnowledgeBase> updateKnowledgeBaseSettings()

Returns the object with the settings used for calls to updateKnowledgeBase.

listLocationsSettings

public PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,KnowledgeBasesClient.ListLocationsPagedResponse> listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

getLocationSettings

public UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()

Returns the object with the settings used for calls to getLocation.

create

public static final KnowledgeBasesSettings create(KnowledgeBasesStubSettings stub)
                                           throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static KnowledgeBasesSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static KnowledgeBasesSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static KnowledgeBasesSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public KnowledgeBasesSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class ClientSettings<KnowledgeBasesSettings>