Class VizierServiceSettings (2.9.5)

See more code actions.
public class VizierServiceSettings extends 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 total timeout of createStudy to 30 seconds:


 VizierServiceSettings.Builder vizierServiceSettingsBuilder = VizierServiceSettings.newBuilder();
 vizierServiceSettingsBuilder
     .createStudySettings()
     .setRetrySettings(
         vizierServiceSettingsBuilder
             .createStudySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 VizierServiceSettings vizierServiceSettings = vizierServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > VizierServiceSettings

Static Methods

create(VizierServiceStubSettings stub)

public static final VizierServiceSettings create(VizierServiceStubSettings stub)
Parameter
NameDescription
stubVizierServiceStubSettings
Returns
TypeDescription
VizierServiceSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static VizierServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

newBuilder(ClientContext clientContext)

public static VizierServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns

Constructors

VizierServiceSettings(VizierServiceSettings.Builder settingsBuilder)

protected VizierServiceSettings(VizierServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderVizierServiceSettings.Builder

Methods

addTrialMeasurementSettings()

public UnaryCallSettings<AddTrialMeasurementRequest,Trial> addTrialMeasurementSettings()

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

Returns

checkTrialEarlyStoppingStateOperationSettings()

public OperationCallSettings<CheckTrialEarlyStoppingStateRequest,CheckTrialEarlyStoppingStateResponse,CheckTrialEarlyStoppingStateMetatdata> checkTrialEarlyStoppingStateOperationSettings()

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

Returns

checkTrialEarlyStoppingStateSettings()

public UnaryCallSettings<CheckTrialEarlyStoppingStateRequest,Operation> checkTrialEarlyStoppingStateSettings()

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

Returns

completeTrialSettings()

public UnaryCallSettings<CompleteTrialRequest,Trial> completeTrialSettings()

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

Returns

createStudySettings()

public UnaryCallSettings<CreateStudyRequest,Study> createStudySettings()

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

Returns

createTrialSettings()

public UnaryCallSettings<CreateTrialRequest,Trial> createTrialSettings()

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

Returns

deleteStudySettings()

public UnaryCallSettings<DeleteStudyRequest,Empty> deleteStudySettings()

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

Returns

deleteTrialSettings()

public UnaryCallSettings<DeleteTrialRequest,Empty> deleteTrialSettings()

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

Returns

getStudySettings()

public UnaryCallSettings<GetStudyRequest,Study> getStudySettings()

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

Returns

getTrialSettings()

public UnaryCallSettings<GetTrialRequest,Trial> getTrialSettings()

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

Returns

listOptimalTrialsSettings()

public UnaryCallSettings<ListOptimalTrialsRequest,ListOptimalTrialsResponse> listOptimalTrialsSettings()

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

Returns

listStudiesSettings()

public PagedCallSettings<ListStudiesRequest,ListStudiesResponse,VizierServiceClient.ListStudiesPagedResponse> listStudiesSettings()

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

Returns

listTrialsSettings()

public PagedCallSettings<ListTrialsRequest,ListTrialsResponse,VizierServiceClient.ListTrialsPagedResponse> listTrialsSettings()

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

Returns

lookupStudySettings()

public UnaryCallSettings<LookupStudyRequest,Study> lookupStudySettings()

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

Returns

stopTrialSettings()

public UnaryCallSettings<StopTrialRequest,Trial> stopTrialSettings()

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

Returns

suggestTrialsOperationSettings()

public OperationCallSettings<SuggestTrialsRequest,SuggestTrialsResponse,SuggestTrialsMetadata> suggestTrialsOperationSettings()

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

Returns

suggestTrialsSettings()

public UnaryCallSettings<SuggestTrialsRequest,Operation> suggestTrialsSettings()

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

Returns

toBuilder()

public VizierServiceSettings.Builder toBuilder()

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

Returns Overrides