Class EvaluationServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<EvaluationServiceSettings>
com.google.cloud.aiplatform.v1beta1.EvaluationServiceSettings
@BetaApi
@Generated("by gapic-generator-java")
public class EvaluationServiceSettings
extends ClientSettings<EvaluationServiceSettings>
Settings class to configure an instance of
EvaluationServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (aiplatform.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 evaluateInstances:
// 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
EvaluationServiceSettings.Builder evaluationServiceSettingsBuilder =
EvaluationServiceSettings.newBuilder();
evaluationServiceSettingsBuilder
.evaluateInstancesSettings()
.setRetrySettings(
evaluationServiceSettingsBuilder
.evaluateInstancesSettings()
.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());
EvaluationServiceSettings evaluationServiceSettings = evaluationServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 evaluateDataset:
// 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
EvaluationServiceSettings.Builder evaluationServiceSettingsBuilder =
EvaluationServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
evaluationServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for EvaluationServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedEvaluationServiceSettings(EvaluationServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final EvaluationServiceSettingsReturns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<EvaluateDatasetRequest,EvaluateDatasetResponse, EvaluateDatasetOperationMetadata> Returns the object with the settings used for calls to evaluateDataset.Returns the object with the settings used for calls to evaluateDataset.Returns the object with the settings used for calls to evaluateInstances.Returns the object with the settings used for calls to generateInstanceRubrics.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, EvaluationServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.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
-
Constructor Details
-
EvaluationServiceSettings
protected EvaluationServiceSettings(EvaluationServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
evaluateInstancesSettings
public UnaryCallSettings<EvaluateInstancesRequest,EvaluateInstancesResponse> evaluateInstancesSettings()Returns the object with the settings used for calls to evaluateInstances. -
evaluateDatasetSettings
Returns the object with the settings used for calls to evaluateDataset. -
evaluateDatasetOperationSettings
public OperationCallSettings<EvaluateDatasetRequest,EvaluateDatasetResponse, evaluateDatasetOperationSettings()EvaluateDatasetOperationMetadata> Returns the object with the settings used for calls to evaluateDataset. -
generateInstanceRubricsSettings
public UnaryCallSettings<GenerateInstanceRubricsRequest,GenerateInstanceRubricsResponse> generateInstanceRubricsSettings()Returns the object with the settings used for calls to generateInstanceRubrics. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()EvaluationServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
create
public static final EvaluationServiceSettings create(EvaluationServiceStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<EvaluationServiceSettings>
-