Class KnowledgeBasesStubSettings (4.5.11)

public class KnowledgeBasesStubSettings extends StubSettings<KnowledgeBasesStubSettings>

Settings class to configure an instance of KnowledgeBasesStub.

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:


 KnowledgeBasesStubSettings.Builder knowledgeBasesSettingsBuilder =
     KnowledgeBasesStubSettings.newBuilder();
 knowledgeBasesSettingsBuilder
     .getKnowledgeBaseSettings()
     .setRetrySettings(
         knowledgeBasesSettingsBuilder
             .getKnowledgeBaseSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 KnowledgeBasesStubSettings knowledgeBasesSettings = knowledgeBasesSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > KnowledgeBasesStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static KnowledgeBasesStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
KnowledgeBasesStubSettings.Builder

newBuilder(ClientContext clientContext)

public static KnowledgeBasesStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
KnowledgeBasesStubSettings.Builder

Constructors

KnowledgeBasesStubSettings(KnowledgeBasesStubSettings.Builder settingsBuilder)

protected KnowledgeBasesStubSettings(KnowledgeBasesStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderKnowledgeBasesStubSettings.Builder

Methods

createKnowledgeBaseSettings()

public UnaryCallSettings<CreateKnowledgeBaseRequest,KnowledgeBase> createKnowledgeBaseSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateKnowledgeBaseRequest,KnowledgeBase>

createStub()

public KnowledgeBasesStub createStub()
Returns
TypeDescription
KnowledgeBasesStub
Exceptions
TypeDescription
IOException

deleteKnowledgeBaseSettings()

public UnaryCallSettings<DeleteKnowledgeBaseRequest,Empty> deleteKnowledgeBaseSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteKnowledgeBaseRequest,Empty>

getKnowledgeBaseSettings()

public UnaryCallSettings<GetKnowledgeBaseRequest,KnowledgeBase> getKnowledgeBaseSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetKnowledgeBaseRequest,KnowledgeBase>

listKnowledgeBasesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListKnowledgeBasesRequest,ListKnowledgeBasesResponse,ListKnowledgeBasesPagedResponse>

toBuilder()

public KnowledgeBasesStubSettings.Builder toBuilder()

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

Returns
TypeDescription
KnowledgeBasesStubSettings.Builder
Overrides

updateKnowledgeBaseSettings()

public UnaryCallSettings<UpdateKnowledgeBaseRequest,KnowledgeBase> updateKnowledgeBaseSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateKnowledgeBaseRequest,KnowledgeBase>