Class AgentsSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<AgentsSettings>
-
- com.google.cloud.dialogflow.cx.v3.AgentsSettings
-
@Generated("by gapic-generator-java") public class AgentsSettings extends com.google.api.gax.rpc.ClientSettings<AgentsSettings>
Settings class to configure an instance ofAgentsClient
.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();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AgentsSettings.Builder
Builder for AgentsSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
AgentsSettings(AgentsSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AgentsSettings
create(AgentsStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateAgentRequest,Agent>
createAgentSettings()
Returns the object with the settings used for calls to createAgent.static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder
defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.static com.google.api.gax.core.InstantiatingExecutorProvider.Builder
defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder
defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteAgentRequest,com.google.protobuf.Empty>
deleteAgentSettings()
Returns the object with the settings used for calls to deleteAgent.com.google.api.gax.rpc.OperationCallSettings<ExportAgentRequest,ExportAgentResponse,com.google.protobuf.Struct>
exportAgentOperationSettings()
Returns the object with the settings used for calls to exportAgent.com.google.api.gax.rpc.UnaryCallSettings<ExportAgentRequest,com.google.longrunning.Operation>
exportAgentSettings()
Returns the object with the settings used for calls to exportAgent.com.google.api.gax.rpc.UnaryCallSettings<GetAgentRequest,Agent>
getAgentSettings()
Returns the object with the settings used for calls to getAgent.com.google.api.gax.rpc.UnaryCallSettings<GetAgentValidationResultRequest,AgentValidationResult>
getAgentValidationResultSettings()
Returns the object with the settings used for calls to getAgentValidationResult.static String
getDefaultEndpoint()
Returns the default service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<GetGenerativeSettingsRequest,GenerativeSettings>
getGenerativeSettingsSettings()
Returns the object with the settings used for calls to getGenerativeSettings.com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>
getLocationSettings()
Returns the object with the settings used for calls to getLocation.com.google.api.gax.rpc.PagedCallSettings<ListAgentsRequest,ListAgentsResponse,AgentsClient.ListAgentsPagedResponse>
listAgentsSettings()
Returns the object with the settings used for calls to listAgents.com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,AgentsClient.ListLocationsPagedResponse>
listLocationsSettings()
Returns the object with the settings used for calls to listLocations.static AgentsSettings.Builder
newBuilder()
Returns a new gRPC builder for this class.static AgentsSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.static AgentsSettings.Builder
newHttpJsonBuilder()
Returns a new REST builder for this class.com.google.api.gax.rpc.OperationCallSettings<RestoreAgentRequest,com.google.protobuf.Empty,com.google.protobuf.Struct>
restoreAgentOperationSettings()
Returns the object with the settings used for calls to restoreAgent.com.google.api.gax.rpc.UnaryCallSettings<RestoreAgentRequest,com.google.longrunning.Operation>
restoreAgentSettings()
Returns the object with the settings used for calls to restoreAgent.AgentsSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.UnaryCallSettings<UpdateAgentRequest,Agent>
updateAgentSettings()
Returns the object with the settings used for calls to updateAgent.com.google.api.gax.rpc.UnaryCallSettings<UpdateGenerativeSettingsRequest,GenerativeSettings>
updateGenerativeSettingsSettings()
Returns the object with the settings used for calls to updateGenerativeSettings.com.google.api.gax.rpc.UnaryCallSettings<ValidateAgentRequest,AgentValidationResult>
validateAgentSettings()
Returns the object with the settings used for calls to validateAgent.-
Methods inherited from class com.google.api.gax.rpc.ClientSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
Constructor Detail
-
AgentsSettings
protected AgentsSettings(AgentsSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
listAgentsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListAgentsRequest,ListAgentsResponse,AgentsClient.ListAgentsPagedResponse> listAgentsSettings()
Returns the object with the settings used for calls to listAgents.
-
getAgentSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetAgentRequest,Agent> getAgentSettings()
Returns the object with the settings used for calls to getAgent.
-
createAgentSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateAgentRequest,Agent> createAgentSettings()
Returns the object with the settings used for calls to createAgent.
-
updateAgentSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateAgentRequest,Agent> updateAgentSettings()
Returns the object with the settings used for calls to updateAgent.
-
deleteAgentSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteAgentRequest,com.google.protobuf.Empty> deleteAgentSettings()
Returns the object with the settings used for calls to deleteAgent.
-
exportAgentSettings
public com.google.api.gax.rpc.UnaryCallSettings<ExportAgentRequest,com.google.longrunning.Operation> exportAgentSettings()
Returns the object with the settings used for calls to exportAgent.
-
exportAgentOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<ExportAgentRequest,ExportAgentResponse,com.google.protobuf.Struct> exportAgentOperationSettings()
Returns the object with the settings used for calls to exportAgent.
-
restoreAgentSettings
public com.google.api.gax.rpc.UnaryCallSettings<RestoreAgentRequest,com.google.longrunning.Operation> restoreAgentSettings()
Returns the object with the settings used for calls to restoreAgent.
-
restoreAgentOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<RestoreAgentRequest,com.google.protobuf.Empty,com.google.protobuf.Struct> restoreAgentOperationSettings()
Returns the object with the settings used for calls to restoreAgent.
-
validateAgentSettings
public com.google.api.gax.rpc.UnaryCallSettings<ValidateAgentRequest,AgentValidationResult> validateAgentSettings()
Returns the object with the settings used for calls to validateAgent.
-
getAgentValidationResultSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetAgentValidationResultRequest,AgentValidationResult> getAgentValidationResultSettings()
Returns the object with the settings used for calls to getAgentValidationResult.
-
getGenerativeSettingsSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetGenerativeSettingsRequest,GenerativeSettings> getGenerativeSettingsSettings()
Returns the object with the settings used for calls to getGenerativeSettings.
-
updateGenerativeSettingsSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateGenerativeSettingsRequest,GenerativeSettings> updateGenerativeSettingsSettings()
Returns the object with the settings used for calls to updateGenerativeSettings.
-
listLocationsSettings
public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,AgentsClient.ListLocationsPagedResponse> listLocationsSettings()
Returns the object with the settings used for calls to listLocations.
-
getLocationSettings
public com.google.api.gax.rpc.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 AgentsSettings create(AgentsStubSettings stub) throws IOException
- Throws:
IOException
-
defaultExecutorProviderBuilder
public static com.google.api.gax.core.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 com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
-
defaultGrpcTransportProviderBuilder
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
-
defaultHttpJsonTransportProviderBuilder
@BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
-
defaultTransportChannelProvider
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
-
defaultApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static AgentsSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
-
newHttpJsonBuilder
@BetaApi public static AgentsSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
-
newBuilder
public static AgentsSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public AgentsSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.ClientSettings<AgentsSettings>
-
-