com.google.cloud.dialogflow.cx.v3beta1.TestCasesSettings Maven / Gradle / Ivy
Show all versions of google-cloud-dialogflow-cx Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.dialogflow.cx.v3beta1;
import static com.google.cloud.dialogflow.cx.v3beta1.TestCasesClient.ListLocationsPagedResponse;
import static com.google.cloud.dialogflow.cx.v3beta1.TestCasesClient.ListTestCaseResultsPagedResponse;
import static com.google.cloud.dialogflow.cx.v3beta1.TestCasesClient.ListTestCasesPagedResponse;
import com.google.api.core.ApiFunction;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.ClientSettings;
import com.google.api.gax.rpc.OperationCallSettings;
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.cloud.dialogflow.cx.v3beta1.stub.TestCasesStubSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.longrunning.Operation;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Settings class to configure an instance of {@link 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:
*
*
{@code
* // 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:
*
*
{@code
* // 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();
* }
*/
@BetaApi
@Generated("by gapic-generator-java")
public class TestCasesSettings extends ClientSettings {
/** Returns the object with the settings used for calls to listTestCases. */
public PagedCallSettings
listTestCasesSettings() {
return ((TestCasesStubSettings) getStubSettings()).listTestCasesSettings();
}
/** Returns the object with the settings used for calls to batchDeleteTestCases. */
public UnaryCallSettings batchDeleteTestCasesSettings() {
return ((TestCasesStubSettings) getStubSettings()).batchDeleteTestCasesSettings();
}
/** Returns the object with the settings used for calls to getTestCase. */
public UnaryCallSettings getTestCaseSettings() {
return ((TestCasesStubSettings) getStubSettings()).getTestCaseSettings();
}
/** Returns the object with the settings used for calls to createTestCase. */
public UnaryCallSettings createTestCaseSettings() {
return ((TestCasesStubSettings) getStubSettings()).createTestCaseSettings();
}
/** Returns the object with the settings used for calls to updateTestCase. */
public UnaryCallSettings updateTestCaseSettings() {
return ((TestCasesStubSettings) getStubSettings()).updateTestCaseSettings();
}
/** Returns the object with the settings used for calls to runTestCase. */
public UnaryCallSettings runTestCaseSettings() {
return ((TestCasesStubSettings) getStubSettings()).runTestCaseSettings();
}
/** Returns the object with the settings used for calls to runTestCase. */
public OperationCallSettings
runTestCaseOperationSettings() {
return ((TestCasesStubSettings) getStubSettings()).runTestCaseOperationSettings();
}
/** Returns the object with the settings used for calls to batchRunTestCases. */
public UnaryCallSettings batchRunTestCasesSettings() {
return ((TestCasesStubSettings) getStubSettings()).batchRunTestCasesSettings();
}
/** Returns the object with the settings used for calls to batchRunTestCases. */
public OperationCallSettings<
BatchRunTestCasesRequest, BatchRunTestCasesResponse, BatchRunTestCasesMetadata>
batchRunTestCasesOperationSettings() {
return ((TestCasesStubSettings) getStubSettings()).batchRunTestCasesOperationSettings();
}
/** Returns the object with the settings used for calls to calculateCoverage. */
public UnaryCallSettings
calculateCoverageSettings() {
return ((TestCasesStubSettings) getStubSettings()).calculateCoverageSettings();
}
/** Returns the object with the settings used for calls to importTestCases. */
public UnaryCallSettings importTestCasesSettings() {
return ((TestCasesStubSettings) getStubSettings()).importTestCasesSettings();
}
/** Returns the object with the settings used for calls to importTestCases. */
public OperationCallSettings<
ImportTestCasesRequest, ImportTestCasesResponse, ImportTestCasesMetadata>
importTestCasesOperationSettings() {
return ((TestCasesStubSettings) getStubSettings()).importTestCasesOperationSettings();
}
/** Returns the object with the settings used for calls to exportTestCases. */
public UnaryCallSettings exportTestCasesSettings() {
return ((TestCasesStubSettings) getStubSettings()).exportTestCasesSettings();
}
/** Returns the object with the settings used for calls to exportTestCases. */
public OperationCallSettings<
ExportTestCasesRequest, ExportTestCasesResponse, ExportTestCasesMetadata>
exportTestCasesOperationSettings() {
return ((TestCasesStubSettings) getStubSettings()).exportTestCasesOperationSettings();
}
/** Returns the object with the settings used for calls to listTestCaseResults. */
public PagedCallSettings<
ListTestCaseResultsRequest, ListTestCaseResultsResponse, ListTestCaseResultsPagedResponse>
listTestCaseResultsSettings() {
return ((TestCasesStubSettings) getStubSettings()).listTestCaseResultsSettings();
}
/** Returns the object with the settings used for calls to getTestCaseResult. */
public UnaryCallSettings getTestCaseResultSettings() {
return ((TestCasesStubSettings) getStubSettings()).getTestCaseResultSettings();
}
/** Returns the object with the settings used for calls to listLocations. */
public PagedCallSettings
listLocationsSettings() {
return ((TestCasesStubSettings) getStubSettings()).listLocationsSettings();
}
/** Returns the object with the settings used for calls to getLocation. */
public UnaryCallSettings getLocationSettings() {
return ((TestCasesStubSettings) getStubSettings()).getLocationSettings();
}
public static final TestCasesSettings create(TestCasesStubSettings stub) throws IOException {
return new TestCasesSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return TestCasesStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return TestCasesStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return TestCasesStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return TestCasesStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return TestCasesStubSettings.defaultGrpcTransportProviderBuilder();
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return TestCasesStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return TestCasesStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return TestCasesStubSettings.defaultApiClientHeaderProviderBuilder();
}
/** Returns a new gRPC builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** Returns a new REST builder for this class. */
public static Builder newHttpJsonBuilder() {
return Builder.createHttpJsonDefault();
}
/** Returns a new builder for this class. */
public static Builder newBuilder(ClientContext clientContext) {
return new Builder(clientContext);
}
/** Returns a builder containing all the values of this settings class. */
public Builder toBuilder() {
return new Builder(this);
}
protected TestCasesSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for TestCasesSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(TestCasesStubSettings.newBuilder(clientContext));
}
protected Builder(TestCasesSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(TestCasesStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(TestCasesStubSettings.newBuilder());
}
private static Builder createHttpJsonDefault() {
return new Builder(TestCasesStubSettings.newHttpJsonBuilder());
}
public TestCasesStubSettings.Builder getStubSettingsBuilder() {
return ((TestCasesStubSettings.Builder) getStubSettings());
}
/**
* Applies the given settings updater function to all of the unary API methods in this service.
*
* Note: This method does not support applying settings to streaming methods.
*/
public Builder applyToAllUnaryMethods(
ApiFunction, Void> settingsUpdater) {
super.applyToAllUnaryMethods(
getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
return this;
}
/** Returns the builder for the settings used for calls to listTestCases. */
public PagedCallSettings.Builder<
ListTestCasesRequest, ListTestCasesResponse, ListTestCasesPagedResponse>
listTestCasesSettings() {
return getStubSettingsBuilder().listTestCasesSettings();
}
/** Returns the builder for the settings used for calls to batchDeleteTestCases. */
public UnaryCallSettings.Builder
batchDeleteTestCasesSettings() {
return getStubSettingsBuilder().batchDeleteTestCasesSettings();
}
/** Returns the builder for the settings used for calls to getTestCase. */
public UnaryCallSettings.Builder getTestCaseSettings() {
return getStubSettingsBuilder().getTestCaseSettings();
}
/** Returns the builder for the settings used for calls to createTestCase. */
public UnaryCallSettings.Builder createTestCaseSettings() {
return getStubSettingsBuilder().createTestCaseSettings();
}
/** Returns the builder for the settings used for calls to updateTestCase. */
public UnaryCallSettings.Builder updateTestCaseSettings() {
return getStubSettingsBuilder().updateTestCaseSettings();
}
/** Returns the builder for the settings used for calls to runTestCase. */
public UnaryCallSettings.Builder runTestCaseSettings() {
return getStubSettingsBuilder().runTestCaseSettings();
}
/** Returns the builder for the settings used for calls to runTestCase. */
public OperationCallSettings.Builder<
RunTestCaseRequest, RunTestCaseResponse, RunTestCaseMetadata>
runTestCaseOperationSettings() {
return getStubSettingsBuilder().runTestCaseOperationSettings();
}
/** Returns the builder for the settings used for calls to batchRunTestCases. */
public UnaryCallSettings.Builder
batchRunTestCasesSettings() {
return getStubSettingsBuilder().batchRunTestCasesSettings();
}
/** Returns the builder for the settings used for calls to batchRunTestCases. */
public OperationCallSettings.Builder<
BatchRunTestCasesRequest, BatchRunTestCasesResponse, BatchRunTestCasesMetadata>
batchRunTestCasesOperationSettings() {
return getStubSettingsBuilder().batchRunTestCasesOperationSettings();
}
/** Returns the builder for the settings used for calls to calculateCoverage. */
public UnaryCallSettings.Builder
calculateCoverageSettings() {
return getStubSettingsBuilder().calculateCoverageSettings();
}
/** Returns the builder for the settings used for calls to importTestCases. */
public UnaryCallSettings.Builder importTestCasesSettings() {
return getStubSettingsBuilder().importTestCasesSettings();
}
/** Returns the builder for the settings used for calls to importTestCases. */
public OperationCallSettings.Builder<
ImportTestCasesRequest, ImportTestCasesResponse, ImportTestCasesMetadata>
importTestCasesOperationSettings() {
return getStubSettingsBuilder().importTestCasesOperationSettings();
}
/** Returns the builder for the settings used for calls to exportTestCases. */
public UnaryCallSettings.Builder exportTestCasesSettings() {
return getStubSettingsBuilder().exportTestCasesSettings();
}
/** Returns the builder for the settings used for calls to exportTestCases. */
public OperationCallSettings.Builder<
ExportTestCasesRequest, ExportTestCasesResponse, ExportTestCasesMetadata>
exportTestCasesOperationSettings() {
return getStubSettingsBuilder().exportTestCasesOperationSettings();
}
/** Returns the builder for the settings used for calls to listTestCaseResults. */
public PagedCallSettings.Builder<
ListTestCaseResultsRequest,
ListTestCaseResultsResponse,
ListTestCaseResultsPagedResponse>
listTestCaseResultsSettings() {
return getStubSettingsBuilder().listTestCaseResultsSettings();
}
/** Returns the builder for the settings used for calls to getTestCaseResult. */
public UnaryCallSettings.Builder
getTestCaseResultSettings() {
return getStubSettingsBuilder().getTestCaseResultSettings();
}
/** Returns the builder for the settings used for calls to listLocations. */
public PagedCallSettings.Builder<
ListLocationsRequest, ListLocationsResponse, ListLocationsPagedResponse>
listLocationsSettings() {
return getStubSettingsBuilder().listLocationsSettings();
}
/** Returns the builder for the settings used for calls to getLocation. */
public UnaryCallSettings.Builder getLocationSettings() {
return getStubSettingsBuilder().getLocationSettings();
}
@Override
public TestCasesSettings build() throws IOException {
return new TestCasesSettings(this);
}
}
}