com.google.cloud.dialogflow.cx.v3beta1

Class ToolsSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<ToolsSettings>

com.google.cloud.dialogflow.cx.v3beta1.ToolsSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class ToolsSettings
extends com.google.api.gax.rpc.ClientSettings<ToolsSettings>

Settings class to configure an instance of ToolsClient.

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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of createTool:

 // 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
 ToolsSettings.Builder toolsSettingsBuilder = ToolsSettings.newBuilder();
 toolsSettingsBuilder
     .createToolSettings()
     .setRetrySettings(
         toolsSettingsBuilder
             .createToolSettings()
             .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());
 ToolsSettings toolsSettings = toolsSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) 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 exportTools:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ToolsSettings.Builder Builder for ToolsSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ToolsSettings(ToolsSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static ToolsSettings	create(ToolsStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateToolRequest,Tool>	createToolSettings() Returns the object with the settings used for calls to createTool.
com.google.api.gax.rpc.UnaryCallSettings<CreateToolVersionRequest,ToolVersion>	createToolVersionSettings() Returns the object with the settings used for calls to createToolVersion.
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<DeleteToolRequest,com.google.protobuf.Empty>	deleteToolSettings() Returns the object with the settings used for calls to deleteTool.
com.google.api.gax.rpc.UnaryCallSettings<DeleteToolVersionRequest,com.google.protobuf.Empty>	deleteToolVersionSettings() Returns the object with the settings used for calls to deleteToolVersion.
com.google.api.gax.rpc.OperationCallSettings<ExportToolsRequest,ExportToolsResponse,ExportToolsMetadata>	exportToolsOperationSettings() Returns the object with the settings used for calls to exportTools.
com.google.api.gax.rpc.UnaryCallSettings<ExportToolsRequest,com.google.longrunning.Operation>	exportToolsSettings() Returns the object with the settings used for calls to exportTools.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
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.UnaryCallSettings<GetToolRequest,Tool>	getToolSettings() Returns the object with the settings used for calls to getTool.
com.google.api.gax.rpc.UnaryCallSettings<GetToolVersionRequest,ToolVersion>	getToolVersionSettings() Returns the object with the settings used for calls to getToolVersion.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ToolsClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
com.google.api.gax.rpc.PagedCallSettings<ListToolsRequest,ListToolsResponse,ToolsClient.ListToolsPagedResponse>	listToolsSettings() Returns the object with the settings used for calls to listTools.
com.google.api.gax.rpc.PagedCallSettings<ListToolVersionsRequest,ListToolVersionsResponse,ToolsClient.ListToolVersionsPagedResponse>	listToolVersionsSettings() Returns the object with the settings used for calls to listToolVersions.
static ToolsSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static ToolsSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static ToolsSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<RestoreToolVersionRequest,RestoreToolVersionResponse>	restoreToolVersionSettings() Returns the object with the settings used for calls to restoreToolVersion.
ToolsSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateToolRequest,Tool>	updateToolSettings() Returns the object with the settings used for calls to updateTool.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ToolsSettings

protected ToolsSettings(ToolsSettings.Builder settingsBuilder)
                 throws IOException

Throws:

IOException

Method Detail

createToolSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateToolRequest,Tool> createToolSettings()

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

listToolsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListToolsRequest,ListToolsResponse,ToolsClient.ListToolsPagedResponse> listToolsSettings()

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

exportToolsSettings

public com.google.api.gax.rpc.UnaryCallSettings<ExportToolsRequest,com.google.longrunning.Operation> exportToolsSettings()

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

exportToolsOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ExportToolsRequest,ExportToolsResponse,ExportToolsMetadata> exportToolsOperationSettings()

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

getToolSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetToolRequest,Tool> getToolSettings()

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

updateToolSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateToolRequest,Tool> updateToolSettings()

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

deleteToolSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteToolRequest,com.google.protobuf.Empty> deleteToolSettings()

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

listToolVersionsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListToolVersionsRequest,ListToolVersionsResponse,ToolsClient.ListToolVersionsPagedResponse> listToolVersionsSettings()

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

createToolVersionSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateToolVersionRequest,ToolVersion> createToolVersionSettings()

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

getToolVersionSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetToolVersionRequest,ToolVersion> getToolVersionSettings()

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

deleteToolVersionSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteToolVersionRequest,com.google.protobuf.Empty> deleteToolVersionSettings()

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

restoreToolVersionSettings

public com.google.api.gax.rpc.UnaryCallSettings<RestoreToolVersionRequest,RestoreToolVersionResponse> restoreToolVersionSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ToolsClient.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 ToolsSettings create(ToolsStubSettings 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

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static ToolsSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static ToolsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static ToolsSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public ToolsSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<ToolsSettings>