Class ContextsSettings (4.4.0)

public class ContextsSettings extends ClientSettings<ContextsSettings>

Settings class to configure an instance of 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:


 ContextsSettings.Builder contextsSettingsBuilder = ContextsSettings.newBuilder();
 contextsSettingsBuilder
     .getContextSettings()
     .setRetrySettings(
         contextsSettingsBuilder
             .getContextSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ContextsSettings contextsSettings = contextsSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > ContextsSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

ContextsSettings(ContextsSettings.Builder settingsBuilder)

protected ContextsSettings(ContextsSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`ContextsSettings.Builder`

Methods

create(ContextsStubSettings stub)

public static final ContextsSettings create(ContextsStubSettings stub)

Parameter

Name	Description
stub	`ContextsStubSettings`

Returns

Type	Description
ContextsSettings

Exceptions

Type	Description
IOException

createContextSettings()

public UnaryCallSettings<CreateContextRequest,Context> createContextSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateContextRequest,Context>

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns

Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns

Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns

Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns

Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
TransportChannelProvider

deleteAllContextsSettings()

public UnaryCallSettings<DeleteAllContextsRequest,Empty> deleteAllContextsSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteAllContextsRequest,Empty>

deleteContextSettings()

public UnaryCallSettings<DeleteContextRequest,Empty> deleteContextSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteContextRequest,Empty>

getContextSettings()

public UnaryCallSettings<GetContextRequest,Context> getContextSettings()

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

Returns

Type	Description
UnaryCallSettings<GetContextRequest,Context>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

listContextsSettings()

public PagedCallSettings<ListContextsRequest,ListContextsResponse,ContextsClient.ListContextsPagedResponse> listContextsSettings()

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

Returns

Type	Description
PagedCallSettings<ListContextsRequest,ListContextsResponse,ListContextsPagedResponse>

newBuilder()

public static ContextsSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
ContextsSettings.Builder

newBuilder(ClientContext clientContext)

public static ContextsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
ContextsSettings.Builder

toBuilder()

public ContextsSettings.Builder toBuilder()

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

Returns

Type	Description
ContextsSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateContextSettings()

public UnaryCallSettings<UpdateContextRequest,Context> updateContextSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateContextRequest,Context>