Class AgentServiceSettings (0.1.0)

public class AgentServiceSettings extends ClientSettings<AgentServiceSettings>

Settings class to configure an instance of AgentServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (ces.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 RetrySettings of getApp:

 // 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
 AgentServiceSettings.Builder agentServiceSettingsBuilder = AgentServiceSettings.newBuilder();
 agentServiceSettingsBuilder
     .getAppSettings()
     .setRetrySettings(
         agentServiceSettingsBuilder
             .getAppSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 AgentServiceSettings agentServiceSettings = agentServiceSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createApp:

 // 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
 AgentServiceSettings.Builder agentServiceSettingsBuilder = AgentServiceSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 agentServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > ClientSettings > AgentServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

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(AgentServiceStubSettings stub)

public static final AgentServiceSettings create(AgentServiceStubSettings stub)

Parameter
Name	Description
stub	AgentServiceStubSettings

Returns
Type	Description
AgentServiceSettings

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()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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 AgentServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
AgentServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static AgentServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
AgentServiceSettings.Builder

newHttpJsonBuilder()

public static AgentServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
AgentServiceSettings.Builder

Constructors

AgentServiceSettings(AgentServiceSettings.Builder settingsBuilder)

protected AgentServiceSettings(AgentServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	AgentServiceSettings.Builder

Methods

batchDeleteConversationsOperationSettings()

public OperationCallSettings<BatchDeleteConversationsRequest,BatchDeleteConversationsResponse,OperationMetadata> batchDeleteConversationsOperationSettings()

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

Returns
Type	Description
OperationCallSettings<BatchDeleteConversationsRequest,BatchDeleteConversationsResponse,OperationMetadata>

batchDeleteConversationsSettings()

public UnaryCallSettings<BatchDeleteConversationsRequest,Operation> batchDeleteConversationsSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchDeleteConversationsRequest,Operation>

createAgentSettings()

public UnaryCallSettings<CreateAgentRequest,Agent> createAgentSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateAgentRequest,Agent>

createAppOperationSettings()

public OperationCallSettings<CreateAppRequest,App,OperationMetadata> createAppOperationSettings()

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

Returns
Type	Description
OperationCallSettings<CreateAppRequest,App,OperationMetadata>

createAppSettings()

public UnaryCallSettings<CreateAppRequest,Operation> createAppSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateAppRequest,Operation>

createAppVersionSettings()

public UnaryCallSettings<CreateAppVersionRequest,AppVersion> createAppVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateAppVersionRequest,AppVersion>

createDeploymentSettings()

public UnaryCallSettings<CreateDeploymentRequest,Deployment> createDeploymentSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateDeploymentRequest,Deployment>

createExampleSettings()

public UnaryCallSettings<CreateExampleRequest,Example> createExampleSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateExampleRequest,Example>

createGuardrailSettings()

public UnaryCallSettings<CreateGuardrailRequest,Guardrail> createGuardrailSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateGuardrailRequest,Guardrail>

createToolSettings()

public UnaryCallSettings<CreateToolRequest,Tool> createToolSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateToolRequest,Tool>

createToolsetSettings()

public UnaryCallSettings<CreateToolsetRequest,Toolset> createToolsetSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateToolsetRequest,Toolset>

deleteAgentSettings()

public UnaryCallSettings<DeleteAgentRequest,Empty> deleteAgentSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteAgentRequest,Empty>

deleteAppOperationSettings()

public OperationCallSettings<DeleteAppRequest,Empty,OperationMetadata> deleteAppOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteAppRequest,Empty,OperationMetadata>

deleteAppSettings()

public UnaryCallSettings<DeleteAppRequest,Operation> deleteAppSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteAppRequest,Operation>

deleteAppVersionSettings()

public UnaryCallSettings<DeleteAppVersionRequest,Empty> deleteAppVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteAppVersionRequest,Empty>

deleteConversationSettings()

public UnaryCallSettings<DeleteConversationRequest,Empty> deleteConversationSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteConversationRequest,Empty>

deleteDeploymentSettings()

public UnaryCallSettings<DeleteDeploymentRequest,Empty> deleteDeploymentSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteDeploymentRequest,Empty>

deleteExampleSettings()

public UnaryCallSettings<DeleteExampleRequest,Empty> deleteExampleSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteExampleRequest,Empty>

deleteGuardrailSettings()

public UnaryCallSettings<DeleteGuardrailRequest,Empty> deleteGuardrailSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteGuardrailRequest,Empty>

deleteToolSettings()

public UnaryCallSettings<DeleteToolRequest,Empty> deleteToolSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteToolRequest,Empty>

deleteToolsetSettings()

public UnaryCallSettings<DeleteToolsetRequest,Empty> deleteToolsetSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteToolsetRequest,Empty>

exportAppOperationSettings()

public OperationCallSettings<ExportAppRequest,ExportAppResponse,OperationMetadata> exportAppOperationSettings()

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

Returns
Type	Description
OperationCallSettings<ExportAppRequest,ExportAppResponse,OperationMetadata>

exportAppSettings()

public UnaryCallSettings<ExportAppRequest,Operation> exportAppSettings()

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

Returns
Type	Description
UnaryCallSettings<ExportAppRequest,Operation>

getAgentSettings()

public UnaryCallSettings<GetAgentRequest,Agent> getAgentSettings()

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

Returns
Type	Description
UnaryCallSettings<GetAgentRequest,Agent>

getAppSettings()

public UnaryCallSettings<GetAppRequest,App> getAppSettings()

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

Returns
Type	Description
UnaryCallSettings<GetAppRequest,App>

getAppVersionSettings()

public UnaryCallSettings<GetAppVersionRequest,AppVersion> getAppVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<GetAppVersionRequest,AppVersion>

getChangelogSettings()

public UnaryCallSettings<GetChangelogRequest,Changelog> getChangelogSettings()

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

Returns
Type	Description
UnaryCallSettings<GetChangelogRequest,Changelog>

getConversationSettings()

public UnaryCallSettings<GetConversationRequest,Conversation> getConversationSettings()

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

Returns
Type	Description
UnaryCallSettings<GetConversationRequest,Conversation>

getDeploymentSettings()

public UnaryCallSettings<GetDeploymentRequest,Deployment> getDeploymentSettings()

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

Returns
Type	Description
UnaryCallSettings<GetDeploymentRequest,Deployment>

getExampleSettings()

public UnaryCallSettings<GetExampleRequest,Example> getExampleSettings()

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

Returns
Type	Description
UnaryCallSettings<GetExampleRequest,Example>

getGuardrailSettings()

public UnaryCallSettings<GetGuardrailRequest,Guardrail> getGuardrailSettings()

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

Returns
Type	Description
UnaryCallSettings<GetGuardrailRequest,Guardrail>

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>

getToolSettings()

public UnaryCallSettings<GetToolRequest,Tool> getToolSettings()

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

Returns
Type	Description
UnaryCallSettings<GetToolRequest,Tool>

getToolsetSettings()

public UnaryCallSettings<GetToolsetRequest,Toolset> getToolsetSettings()

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

Returns
Type	Description
UnaryCallSettings<GetToolsetRequest,Toolset>

importAppOperationSettings()

public OperationCallSettings<ImportAppRequest,ImportAppResponse,OperationMetadata> importAppOperationSettings()

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

Returns
Type	Description
OperationCallSettings<ImportAppRequest,ImportAppResponse,OperationMetadata>

importAppSettings()

public UnaryCallSettings<ImportAppRequest,Operation> importAppSettings()

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

Returns
Type	Description
UnaryCallSettings<ImportAppRequest,Operation>

listAgentsSettings()

public PagedCallSettings<ListAgentsRequest,ListAgentsResponse,AgentServiceClient.ListAgentsPagedResponse> listAgentsSettings()

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

Returns
Type	Description
PagedCallSettings<ListAgentsRequest,ListAgentsResponse,ListAgentsPagedResponse>

listAppVersionsSettings()

public PagedCallSettings<ListAppVersionsRequest,ListAppVersionsResponse,AgentServiceClient.ListAppVersionsPagedResponse> listAppVersionsSettings()

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

Returns
Type	Description
PagedCallSettings<ListAppVersionsRequest,ListAppVersionsResponse,ListAppVersionsPagedResponse>

listAppsSettings()

public PagedCallSettings<ListAppsRequest,ListAppsResponse,AgentServiceClient.ListAppsPagedResponse> listAppsSettings()

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

Returns
Type	Description
PagedCallSettings<ListAppsRequest,ListAppsResponse,ListAppsPagedResponse>

listChangelogsSettings()

public PagedCallSettings<ListChangelogsRequest,ListChangelogsResponse,AgentServiceClient.ListChangelogsPagedResponse> listChangelogsSettings()

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

Returns
Type	Description
PagedCallSettings<ListChangelogsRequest,ListChangelogsResponse,ListChangelogsPagedResponse>

listConversationsSettings()

public PagedCallSettings<ListConversationsRequest,ListConversationsResponse,AgentServiceClient.ListConversationsPagedResponse> listConversationsSettings()

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

Returns
Type	Description
PagedCallSettings<ListConversationsRequest,ListConversationsResponse,ListConversationsPagedResponse>

listDeploymentsSettings()

public PagedCallSettings<ListDeploymentsRequest,ListDeploymentsResponse,AgentServiceClient.ListDeploymentsPagedResponse> listDeploymentsSettings()

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

Returns
Type	Description
PagedCallSettings<ListDeploymentsRequest,ListDeploymentsResponse,ListDeploymentsPagedResponse>

listExamplesSettings()

public PagedCallSettings<ListExamplesRequest,ListExamplesResponse,AgentServiceClient.ListExamplesPagedResponse> listExamplesSettings()

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

Returns
Type	Description
PagedCallSettings<ListExamplesRequest,ListExamplesResponse,ListExamplesPagedResponse>

listGuardrailsSettings()

public PagedCallSettings<ListGuardrailsRequest,ListGuardrailsResponse,AgentServiceClient.ListGuardrailsPagedResponse> listGuardrailsSettings()

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

Returns
Type	Description
PagedCallSettings<ListGuardrailsRequest,ListGuardrailsResponse,ListGuardrailsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,AgentServiceClient.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>

listToolsSettings()

public PagedCallSettings<ListToolsRequest,ListToolsResponse,AgentServiceClient.ListToolsPagedResponse> listToolsSettings()

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

Returns
Type	Description
PagedCallSettings<ListToolsRequest,ListToolsResponse,ListToolsPagedResponse>

listToolsetsSettings()

public PagedCallSettings<ListToolsetsRequest,ListToolsetsResponse,AgentServiceClient.ListToolsetsPagedResponse> listToolsetsSettings()

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

Returns
Type	Description
PagedCallSettings<ListToolsetsRequest,ListToolsetsResponse,ListToolsetsPagedResponse>

restoreAppVersionOperationSettings()

public OperationCallSettings<RestoreAppVersionRequest,RestoreAppVersionResponse,OperationMetadata> restoreAppVersionOperationSettings()

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

Returns
Type	Description
OperationCallSettings<RestoreAppVersionRequest,RestoreAppVersionResponse,OperationMetadata>

restoreAppVersionSettings()

public UnaryCallSettings<RestoreAppVersionRequest,Operation> restoreAppVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<RestoreAppVersionRequest,Operation>

toBuilder()

public AgentServiceSettings.Builder toBuilder()

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

Returns
Type	Description
AgentServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateAgentSettings()

public UnaryCallSettings<UpdateAgentRequest,Agent> updateAgentSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateAgentRequest,Agent>

updateAppSettings()

public UnaryCallSettings<UpdateAppRequest,App> updateAppSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateAppRequest,App>

updateDeploymentSettings()

public UnaryCallSettings<UpdateDeploymentRequest,Deployment> updateDeploymentSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateDeploymentRequest,Deployment>

updateExampleSettings()

public UnaryCallSettings<UpdateExampleRequest,Example> updateExampleSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateExampleRequest,Example>

updateGuardrailSettings()

public UnaryCallSettings<UpdateGuardrailRequest,Guardrail> updateGuardrailSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateGuardrailRequest,Guardrail>

updateToolSettings()

public UnaryCallSettings<UpdateToolRequest,Tool> updateToolSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateToolRequest,Tool>

updateToolsetSettings()

public UnaryCallSettings<UpdateToolsetRequest,Toolset> updateToolsetSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateToolsetRequest,Toolset>