com.google.cloud.dialogflow.cx.v3

Class TestCasesSettings

java.lang.Object

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

com.google.cloud.dialogflow.cx.v3.TestCasesSettings

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

Settings class to configure an instance of TestCasesClient.

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 batchDeleteTestCases:

 // 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
 TestCasesSettings.Builder testCasesSettingsBuilder = TestCasesSettings.newBuilder();
 testCasesSettingsBuilder
     .batchDeleteTestCasesSettings()
     .setRetrySettings(
         testCasesSettingsBuilder
             .batchDeleteTestCasesSettings()
             .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());
 TestCasesSettings testCasesSettings = testCasesSettingsBuilder.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 runTestCase:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<BatchDeleteTestCasesRequest,com.google.protobuf.Empty>	batchDeleteTestCasesSettings() Returns the object with the settings used for calls to batchDeleteTestCases.
com.google.api.gax.rpc.OperationCallSettings<BatchRunTestCasesRequest,BatchRunTestCasesResponse,BatchRunTestCasesMetadata>	batchRunTestCasesOperationSettings() Returns the object with the settings used for calls to batchRunTestCases.
com.google.api.gax.rpc.UnaryCallSettings<BatchRunTestCasesRequest,com.google.longrunning.Operation>	batchRunTestCasesSettings() Returns the object with the settings used for calls to batchRunTestCases.
com.google.api.gax.rpc.UnaryCallSettings<CalculateCoverageRequest,CalculateCoverageResponse>	calculateCoverageSettings() Returns the object with the settings used for calls to calculateCoverage.
static TestCasesSettings	create(TestCasesStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateTestCaseRequest,TestCase>	createTestCaseSettings() Returns the object with the settings used for calls to createTestCase.
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.OperationCallSettings<ExportTestCasesRequest,ExportTestCasesResponse,ExportTestCasesMetadata>	exportTestCasesOperationSettings() Returns the object with the settings used for calls to exportTestCases.
com.google.api.gax.rpc.UnaryCallSettings<ExportTestCasesRequest,com.google.longrunning.Operation>	exportTestCasesSettings() Returns the object with the settings used for calls to exportTestCases.
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<GetTestCaseResultRequest,TestCaseResult>	getTestCaseResultSettings() Returns the object with the settings used for calls to getTestCaseResult.
com.google.api.gax.rpc.UnaryCallSettings<GetTestCaseRequest,TestCase>	getTestCaseSettings() Returns the object with the settings used for calls to getTestCase.
com.google.api.gax.rpc.OperationCallSettings<ImportTestCasesRequest,ImportTestCasesResponse,ImportTestCasesMetadata>	importTestCasesOperationSettings() Returns the object with the settings used for calls to importTestCases.
com.google.api.gax.rpc.UnaryCallSettings<ImportTestCasesRequest,com.google.longrunning.Operation>	importTestCasesSettings() Returns the object with the settings used for calls to importTestCases.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,TestCasesClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
com.google.api.gax.rpc.PagedCallSettings<ListTestCaseResultsRequest,ListTestCaseResultsResponse,TestCasesClient.ListTestCaseResultsPagedResponse>	listTestCaseResultsSettings() Returns the object with the settings used for calls to listTestCaseResults.
com.google.api.gax.rpc.PagedCallSettings<ListTestCasesRequest,ListTestCasesResponse,TestCasesClient.ListTestCasesPagedResponse>	listTestCasesSettings() Returns the object with the settings used for calls to listTestCases.
static TestCasesSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static TestCasesSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static TestCasesSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.OperationCallSettings<RunTestCaseRequest,RunTestCaseResponse,RunTestCaseMetadata>	runTestCaseOperationSettings() Returns the object with the settings used for calls to runTestCase.
com.google.api.gax.rpc.UnaryCallSettings<RunTestCaseRequest,com.google.longrunning.Operation>	runTestCaseSettings() Returns the object with the settings used for calls to runTestCase.
TestCasesSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateTestCaseRequest,TestCase>	updateTestCaseSettings() Returns the object with the settings used for calls to updateTestCase.

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

TestCasesSettings

protected TestCasesSettings(TestCasesSettings.Builder settingsBuilder)
                     throws IOException

Throws:

IOException

Method Detail

listTestCasesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTestCasesRequest,ListTestCasesResponse,TestCasesClient.ListTestCasesPagedResponse> listTestCasesSettings()

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

batchDeleteTestCasesSettings

public com.google.api.gax.rpc.UnaryCallSettings<BatchDeleteTestCasesRequest,com.google.protobuf.Empty> batchDeleteTestCasesSettings()

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

getTestCaseSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetTestCaseRequest,TestCase> getTestCaseSettings()

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

createTestCaseSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateTestCaseRequest,TestCase> createTestCaseSettings()

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

updateTestCaseSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateTestCaseRequest,TestCase> updateTestCaseSettings()

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

runTestCaseSettings

public com.google.api.gax.rpc.UnaryCallSettings<RunTestCaseRequest,com.google.longrunning.Operation> runTestCaseSettings()

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

runTestCaseOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<RunTestCaseRequest,RunTestCaseResponse,RunTestCaseMetadata> runTestCaseOperationSettings()

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

batchRunTestCasesSettings

public com.google.api.gax.rpc.UnaryCallSettings<BatchRunTestCasesRequest,com.google.longrunning.Operation> batchRunTestCasesSettings()

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

batchRunTestCasesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<BatchRunTestCasesRequest,BatchRunTestCasesResponse,BatchRunTestCasesMetadata> batchRunTestCasesOperationSettings()

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

calculateCoverageSettings

public com.google.api.gax.rpc.UnaryCallSettings<CalculateCoverageRequest,CalculateCoverageResponse> calculateCoverageSettings()

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

importTestCasesSettings

public com.google.api.gax.rpc.UnaryCallSettings<ImportTestCasesRequest,com.google.longrunning.Operation> importTestCasesSettings()

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

importTestCasesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ImportTestCasesRequest,ImportTestCasesResponse,ImportTestCasesMetadata> importTestCasesOperationSettings()

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

exportTestCasesSettings

public com.google.api.gax.rpc.UnaryCallSettings<ExportTestCasesRequest,com.google.longrunning.Operation> exportTestCasesSettings()

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

exportTestCasesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ExportTestCasesRequest,ExportTestCasesResponse,ExportTestCasesMetadata> exportTestCasesOperationSettings()

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

listTestCaseResultsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTestCaseResultsRequest,ListTestCaseResultsResponse,TestCasesClient.ListTestCaseResultsPagedResponse> listTestCaseResultsSettings()

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

getTestCaseResultSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetTestCaseResultRequest,TestCaseResult> getTestCaseResultSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,TestCasesClient.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 TestCasesSettings create(TestCasesStubSettings 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 TestCasesSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static TestCasesSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public TestCasesSettings.Builder toBuilder()

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

Specified by:

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