Class AgentsSettings (4.4.0)

public class AgentsSettings extends ClientSettings<AgentsSettings>

Settings class to configure an instance of AgentsClient.

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 getAgent to 30 seconds:


 AgentsSettings.Builder agentsSettingsBuilder = AgentsSettings.newBuilder();
 agentsSettingsBuilder
     .getAgentSettings()
     .setRetrySettings(
         agentsSettingsBuilder
             .getAgentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AgentsSettings agentsSettings = agentsSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > AgentsSettings

Constructors

AgentsSettings(AgentsSettings.Builder settingsBuilder)

protected AgentsSettings(AgentsSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderAgentsSettings.Builder

Methods

create(AgentsStubSettings stub)

public static final AgentsSettings create(AgentsStubSettings stub)
Parameter
NameDescription
stubAgentsStubSettings
Returns
TypeDescription
AgentsSettings
Exceptions
TypeDescription
IOException

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

deleteAgentSettings()

public UnaryCallSettings<DeleteAgentRequest,Empty> deleteAgentSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteAgentRequest,Empty>

exportAgentOperationSettings()

public OperationCallSettings<ExportAgentRequest,ExportAgentResponse,Struct> exportAgentOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<ExportAgentRequest,ExportAgentResponse,Struct>

exportAgentSettings()

public UnaryCallSettings<ExportAgentRequest,Operation> exportAgentSettings()

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

Returns
TypeDescription
UnaryCallSettings<ExportAgentRequest,Operation>

getAgentSettings()

public UnaryCallSettings<GetAgentRequest,Agent> getAgentSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAgentRequest,Agent>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

getValidationResultSettings()

public UnaryCallSettings<GetValidationResultRequest,ValidationResult> getValidationResultSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetValidationResultRequest,ValidationResult>

importAgentOperationSettings()

public OperationCallSettings<ImportAgentRequest,Empty,Struct> importAgentOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<ImportAgentRequest,Empty,Struct>

importAgentSettings()

public UnaryCallSettings<ImportAgentRequest,Operation> importAgentSettings()

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

Returns
TypeDescription
UnaryCallSettings<ImportAgentRequest,Operation>

newBuilder()

public static AgentsSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
AgentsSettings.Builder

newBuilder(ClientContext clientContext)

public static AgentsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
AgentsSettings.Builder

restoreAgentOperationSettings()

public OperationCallSettings<RestoreAgentRequest,Empty,Struct> restoreAgentOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<RestoreAgentRequest,Empty,Struct>

restoreAgentSettings()

public UnaryCallSettings<RestoreAgentRequest,Operation> restoreAgentSettings()

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

Returns
TypeDescription
UnaryCallSettings<RestoreAgentRequest,Operation>

searchAgentsSettings()

public PagedCallSettings<SearchAgentsRequest,SearchAgentsResponse,AgentsClient.SearchAgentsPagedResponse> searchAgentsSettings()

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

Returns
TypeDescription
PagedCallSettings<SearchAgentsRequest,SearchAgentsResponse,SearchAgentsPagedResponse>

setAgentSettings()

public UnaryCallSettings<SetAgentRequest,Agent> setAgentSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetAgentRequest,Agent>

toBuilder()

public AgentsSettings.Builder toBuilder()

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

Returns
TypeDescription
AgentsSettings.Builder
Overrides

trainAgentOperationSettings()

public OperationCallSettings<TrainAgentRequest,Empty,Struct> trainAgentOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<TrainAgentRequest,Empty,Struct>

trainAgentSettings()

public UnaryCallSettings<TrainAgentRequest,Operation> trainAgentSettings()

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

Returns
TypeDescription
UnaryCallSettings<TrainAgentRequest,Operation>