com.google.cloud.aiplatform.v1

Class VizierServiceSettings

java.lang.Object

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

com.google.cloud.aiplatform.v1.VizierServiceSettings

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

Settings class to configure an instance of VizierServiceClient.

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
 VizierServiceSettings.Builder vizierServiceSettingsBuilder = VizierServiceSettings.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());
 VizierServiceSettings vizierServiceSettings = vizierServiceSettingsBuilder.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 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
 VizierServiceSettings.Builder vizierServiceSettingsBuilder = VizierServiceSettings.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 Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<AddTrialMeasurementRequest,Trial>	addTrialMeasurementSettings() Returns the object with the settings used for calls to addTrialMeasurement.
com.google.api.gax.rpc.OperationCallSettings<CheckTrialEarlyStoppingStateRequest,CheckTrialEarlyStoppingStateResponse,CheckTrialEarlyStoppingStateMetatdata>	checkTrialEarlyStoppingStateOperationSettings() Returns the object with the settings used for calls to checkTrialEarlyStoppingState.
com.google.api.gax.rpc.UnaryCallSettings<CheckTrialEarlyStoppingStateRequest,com.google.longrunning.Operation>	checkTrialEarlyStoppingStateSettings() Returns the object with the settings used for calls to checkTrialEarlyStoppingState.
com.google.api.gax.rpc.UnaryCallSettings<CompleteTrialRequest,Trial>	completeTrialSettings() Returns the object with the settings used for calls to completeTrial.
static VizierServiceSettings	create(VizierServiceStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateStudyRequest,Study>	createStudySettings() Returns the object with the settings used for calls to createStudy.
com.google.api.gax.rpc.UnaryCallSettings<CreateTrialRequest,Trial>	createTrialSettings() Returns the object with the settings used for calls to createTrial.
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 ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteStudyRequest,com.google.protobuf.Empty>	deleteStudySettings() Returns the object with the settings used for calls to deleteStudy.
com.google.api.gax.rpc.UnaryCallSettings<DeleteTrialRequest,com.google.protobuf.Empty>	deleteTrialSettings() Returns the object with the settings used for calls to deleteTrial.
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.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
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<GetStudyRequest,Study>	getStudySettings() Returns the object with the settings used for calls to getStudy.
com.google.api.gax.rpc.UnaryCallSettings<GetTrialRequest,Trial>	getTrialSettings() Returns the object with the settings used for calls to getTrial.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,VizierServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
com.google.api.gax.rpc.UnaryCallSettings<ListOptimalTrialsRequest,ListOptimalTrialsResponse>	listOptimalTrialsSettings() Returns the object with the settings used for calls to listOptimalTrials.
com.google.api.gax.rpc.PagedCallSettings<ListStudiesRequest,ListStudiesResponse,VizierServiceClient.ListStudiesPagedResponse>	listStudiesSettings() Returns the object with the settings used for calls to listStudies.
com.google.api.gax.rpc.PagedCallSettings<ListTrialsRequest,ListTrialsResponse,VizierServiceClient.ListTrialsPagedResponse>	listTrialsSettings() Returns the object with the settings used for calls to listTrials.
com.google.api.gax.rpc.UnaryCallSettings<LookupStudyRequest,Study>	lookupStudySettings() Returns the object with the settings used for calls to lookupStudy.
static VizierServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static VizierServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<StopTrialRequest,Trial>	stopTrialSettings() Returns the object with the settings used for calls to stopTrial.
com.google.api.gax.rpc.OperationCallSettings<SuggestTrialsRequest,SuggestTrialsResponse,SuggestTrialsMetadata>	suggestTrialsOperationSettings() Returns the object with the settings used for calls to suggestTrials.
com.google.api.gax.rpc.UnaryCallSettings<SuggestTrialsRequest,com.google.longrunning.Operation>	suggestTrialsSettings() Returns the object with the settings used for calls to suggestTrials.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
VizierServiceSettings.Builder	toBuilder() 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

Methods inherited from class java.lang.Object

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

Constructor Detail

VizierServiceSettings

protected VizierServiceSettings(VizierServiceSettings.Builder settingsBuilder)
                         throws IOException

Throws:

IOException

Method Detail

createStudySettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateStudyRequest,Study> createStudySettings()

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

getStudySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetStudyRequest,Study> getStudySettings()

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

listStudiesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListStudiesRequest,ListStudiesResponse,VizierServiceClient.ListStudiesPagedResponse> listStudiesSettings()

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

deleteStudySettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteStudyRequest,com.google.protobuf.Empty> deleteStudySettings()

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

lookupStudySettings

public com.google.api.gax.rpc.UnaryCallSettings<LookupStudyRequest,Study> lookupStudySettings()

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

suggestTrialsSettings

public com.google.api.gax.rpc.UnaryCallSettings<SuggestTrialsRequest,com.google.longrunning.Operation> suggestTrialsSettings()

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

suggestTrialsOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SuggestTrialsRequest,SuggestTrialsResponse,SuggestTrialsMetadata> suggestTrialsOperationSettings()

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

createTrialSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateTrialRequest,Trial> createTrialSettings()

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

getTrialSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetTrialRequest,Trial> getTrialSettings()

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

listTrialsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTrialsRequest,ListTrialsResponse,VizierServiceClient.ListTrialsPagedResponse> listTrialsSettings()

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

addTrialMeasurementSettings

public com.google.api.gax.rpc.UnaryCallSettings<AddTrialMeasurementRequest,Trial> addTrialMeasurementSettings()

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

completeTrialSettings

public com.google.api.gax.rpc.UnaryCallSettings<CompleteTrialRequest,Trial> completeTrialSettings()

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

deleteTrialSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteTrialRequest,com.google.protobuf.Empty> deleteTrialSettings()

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

checkTrialEarlyStoppingStateSettings

public com.google.api.gax.rpc.UnaryCallSettings<CheckTrialEarlyStoppingStateRequest,com.google.longrunning.Operation> checkTrialEarlyStoppingStateSettings()

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

checkTrialEarlyStoppingStateOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CheckTrialEarlyStoppingStateRequest,CheckTrialEarlyStoppingStateResponse,CheckTrialEarlyStoppingStateMetatdata> checkTrialEarlyStoppingStateOperationSettings()

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

stopTrialSettings

public com.google.api.gax.rpc.UnaryCallSettings<StopTrialRequest,Trial> stopTrialSettings()

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

listOptimalTrialsSettings

public com.google.api.gax.rpc.UnaryCallSettings<ListOptimalTrialsRequest,ListOptimalTrialsResponse> listOptimalTrialsSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,VizierServiceClient.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.

setIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

getIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

testIamPermissionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

create

public static final VizierServiceSettings create(VizierServiceStubSettings 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 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 VizierServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public VizierServiceSettings.Builder toBuilder()

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

Specified by:

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