Class AgentsSettings (4.10.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:


 // 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
 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

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)

Static Methods

create(AgentsStubSettings stub)

public static final AgentsSettings create(AgentsStubSettings stub)

Parameter

Name	Description
stub	`AgentsStubSettings`

Returns

Type	Description
AgentsSettings

Exceptions

Type	Description
IOException

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 gRPC ChannelProvider for this service.

Returns

Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns

Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
TransportChannelProvider

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>

newBuilder()

public static AgentsSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

Type	Description
AgentsSettings.Builder

newBuilder(ClientContext clientContext)

public static AgentsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
AgentsSettings.Builder

newHttpJsonBuilder()

public static AgentsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Type	Description
AgentsSettings.Builder

Constructors

AgentsSettings(AgentsSettings.Builder settingsBuilder)

protected AgentsSettings(AgentsSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`AgentsSettings.Builder`

Methods

deleteAgentSettings()

public UnaryCallSettings<DeleteAgentRequest,Empty> deleteAgentSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteAgentRequest,Empty>

exportAgentOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<ExportAgentRequest,ExportAgentResponse,Struct>

exportAgentSettings()

public UnaryCallSettings<ExportAgentRequest,Operation> exportAgentSettings()

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

Returns

Type	Description
UnaryCallSettings<ExportAgentRequest,Operation>

getAgentSettings()

public UnaryCallSettings<GetAgentRequest,Agent> getAgentSettings()

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

Returns

Type	Description
UnaryCallSettings<GetAgentRequest,Agent>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns

Type	Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getValidationResultSettings()

public UnaryCallSettings<GetValidationResultRequest,ValidationResult> getValidationResultSettings()

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

Returns

Type	Description
UnaryCallSettings<GetValidationResultRequest,ValidationResult>

importAgentOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<ImportAgentRequest,Empty,Struct>

importAgentSettings()

public UnaryCallSettings<ImportAgentRequest,Operation> importAgentSettings()

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

Returns

Type	Description
UnaryCallSettings<ImportAgentRequest,Operation>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,AgentsClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns

Type	Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

restoreAgentOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<RestoreAgentRequest,Empty,Struct>

restoreAgentSettings()

public UnaryCallSettings<RestoreAgentRequest,Operation> restoreAgentSettings()

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

Returns

Type	Description
UnaryCallSettings<RestoreAgentRequest,Operation>

searchAgentsSettings()

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

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

Returns

Type	Description
PagedCallSettings<SearchAgentsRequest,SearchAgentsResponse,SearchAgentsPagedResponse>

setAgentSettings()

public UnaryCallSettings<SetAgentRequest,Agent> setAgentSettings()

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

Returns

Type	Description
UnaryCallSettings<SetAgentRequest,Agent>

toBuilder()

public AgentsSettings.Builder toBuilder()

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

Returns

Type	Description
AgentsSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

trainAgentOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<TrainAgentRequest,Empty,Struct>

trainAgentSettings()

public UnaryCallSettings<TrainAgentRequest,Operation> trainAgentSettings()

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

Returns

Type	Description
UnaryCallSettings<TrainAgentRequest,Operation>