Class VizierServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<VizierServiceStubSettings>
com.google.cloud.aiplatform.v1.stub.VizierServiceStubSettings
@Generated("by gapic-generator-java")
public class VizierServiceStubSettings
extends StubSettings<VizierServiceStubSettings>
Settings class to configure an instance of
VizierServiceStub.
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 createStudy:
// 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
VizierServiceStubSettings.Builder vizierServiceSettingsBuilder =
VizierServiceStubSettings.newBuilder();
vizierServiceSettingsBuilder
.createStudySettings()
.setRetrySettings(
vizierServiceSettingsBuilder
.createStudySettings()
.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());
VizierServiceStubSettings vizierServiceSettings = vizierServiceSettingsBuilder.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 suggestTrials:
// 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
VizierServiceStubSettings.Builder vizierServiceSettingsBuilder =
VizierServiceStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
vizierServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for VizierServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedVizierServiceStubSettings(VizierServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to addTrialMeasurement.OperationCallSettings<CheckTrialEarlyStoppingStateRequest,CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata> Returns the object with the settings used for calls to checkTrialEarlyStoppingState.Returns the object with the settings used for calls to checkTrialEarlyStoppingState.Returns the object with the settings used for calls to completeTrial.Returns the object with the settings used for calls to createStudy.Returns the object with the settings used for calls to createTrial.Returns 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 TransportChannelProviderUnaryCallSettings<DeleteStudyRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteStudy.UnaryCallSettings<DeleteTrialRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteTrial.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the default service name.Returns the object with the settings used for calls to getStudy.Returns the object with the settings used for calls to getTrial.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, VizierServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns the object with the settings used for calls to listOptimalTrials.PagedCallSettings<ListStudiesRequest,ListStudiesResponse, VizierServiceClient.ListStudiesPagedResponse> Returns the object with the settings used for calls to listStudies.Returns the object with the settings used for calls to listTrials.Returns the object with the settings used for calls to lookupStudy.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 stopTrial.Returns the object with the settings used for calls to suggestTrials.Returns the object with the settings used for calls to suggestTrials.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.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
VizierServiceStubSettings
protected VizierServiceStubSettings(VizierServiceStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createStudySettings
Returns the object with the settings used for calls to createStudy. -
getStudySettings
Returns the object with the settings used for calls to getStudy. -
listStudiesSettings
public PagedCallSettings<ListStudiesRequest,ListStudiesResponse, listStudiesSettings()VizierServiceClient.ListStudiesPagedResponse> Returns the object with the settings used for calls to listStudies. -
deleteStudySettings
Returns the object with the settings used for calls to deleteStudy. -
lookupStudySettings
Returns the object with the settings used for calls to lookupStudy. -
suggestTrialsSettings
Returns the object with the settings used for calls to suggestTrials. -
suggestTrialsOperationSettings
public OperationCallSettings<SuggestTrialsRequest,SuggestTrialsResponse, suggestTrialsOperationSettings()SuggestTrialsMetadata> Returns the object with the settings used for calls to suggestTrials. -
createTrialSettings
Returns the object with the settings used for calls to createTrial. -
getTrialSettings
Returns the object with the settings used for calls to getTrial. -
listTrialsSettings
public PagedCallSettings<ListTrialsRequest,ListTrialsResponse, listTrialsSettings()VizierServiceClient.ListTrialsPagedResponse> Returns the object with the settings used for calls to listTrials. -
addTrialMeasurementSettings
Returns the object with the settings used for calls to addTrialMeasurement. -
completeTrialSettings
Returns the object with the settings used for calls to completeTrial. -
deleteTrialSettings
Returns the object with the settings used for calls to deleteTrial. -
checkTrialEarlyStoppingStateSettings
public UnaryCallSettings<CheckTrialEarlyStoppingStateRequest,Operation> checkTrialEarlyStoppingStateSettings()Returns the object with the settings used for calls to checkTrialEarlyStoppingState. -
checkTrialEarlyStoppingStateOperationSettings
public OperationCallSettings<CheckTrialEarlyStoppingStateRequest,CheckTrialEarlyStoppingStateResponse, checkTrialEarlyStoppingStateOperationSettings()CheckTrialEarlyStoppingStateMetatdata> Returns the object with the settings used for calls to checkTrialEarlyStoppingState. -
stopTrialSettings
Returns the object with the settings used for calls to stopTrial. -
listOptimalTrialsSettings
public UnaryCallSettings<ListOptimalTrialsRequest,ListOptimalTrialsResponse> listOptimalTrialsSettings()Returns the object with the settings used for calls to listOptimalTrials. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()VizierServiceClient.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. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<VizierServiceStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS 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 classStubSettings<VizierServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<VizierServiceStubSettings>
-