Class VizierServiceSettings (3.15.0)

Version 3.15.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

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:

 // 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()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 VizierServiceSettings vizierServiceSettings = vizierServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > VizierServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(VizierServiceStubSettings stub)

public static final VizierServiceSettings create(VizierServiceStubSettings stub)

Parameter
Name	Description
stub	VizierServiceStubSettings

Returns
Type	Description
VizierServiceSettings

Exceptions
Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
List<String>

newBuilder()

public static VizierServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
VizierServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static VizierServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
VizierServiceSettings.Builder

Constructors

VizierServiceSettings(VizierServiceSettings.Builder settingsBuilder)

protected VizierServiceSettings(VizierServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	VizierServiceSettings.Builder

Methods

addTrialMeasurementSettings()

public UnaryCallSettings<AddTrialMeasurementRequest,Trial> addTrialMeasurementSettings()

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

Returns
Type	Description
UnaryCallSettings<AddTrialMeasurementRequest,Trial>

checkTrialEarlyStoppingStateOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<CheckTrialEarlyStoppingStateRequest,CheckTrialEarlyStoppingStateResponse,CheckTrialEarlyStoppingStateMetatdata>

checkTrialEarlyStoppingStateSettings()

public UnaryCallSettings<CheckTrialEarlyStoppingStateRequest,Operation> checkTrialEarlyStoppingStateSettings()

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

Returns
Type	Description
UnaryCallSettings<CheckTrialEarlyStoppingStateRequest,Operation>

completeTrialSettings()

public UnaryCallSettings<CompleteTrialRequest,Trial> completeTrialSettings()

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

Returns
Type	Description
UnaryCallSettings<CompleteTrialRequest,Trial>

createStudySettings()

public UnaryCallSettings<CreateStudyRequest,Study> createStudySettings()

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

Returns
Type	Description
UnaryCallSettings<CreateStudyRequest,Study>

createTrialSettings()

public UnaryCallSettings<CreateTrialRequest,Trial> createTrialSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateTrialRequest,Trial>

deleteStudySettings()

public UnaryCallSettings<DeleteStudyRequest,Empty> deleteStudySettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteStudyRequest,Empty>

deleteTrialSettings()

public UnaryCallSettings<DeleteTrialRequest,Empty> deleteTrialSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteTrialRequest,Empty>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getStudySettings()

public UnaryCallSettings<GetStudyRequest,Study> getStudySettings()

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

Returns
Type	Description
UnaryCallSettings<GetStudyRequest,Study>

getTrialSettings()

public UnaryCallSettings<GetTrialRequest,Trial> getTrialSettings()

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

Returns
Type	Description
UnaryCallSettings<GetTrialRequest,Trial>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,VizierServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type	Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listOptimalTrialsSettings()

public UnaryCallSettings<ListOptimalTrialsRequest,ListOptimalTrialsResponse> listOptimalTrialsSettings()

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

Returns
Type	Description
UnaryCallSettings<ListOptimalTrialsRequest,ListOptimalTrialsResponse>

listStudiesSettings()

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

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

Returns
Type	Description
PagedCallSettings<ListStudiesRequest,ListStudiesResponse,ListStudiesPagedResponse>

listTrialsSettings()

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

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

Returns
Type	Description
PagedCallSettings<ListTrialsRequest,ListTrialsResponse,ListTrialsPagedResponse>

lookupStudySettings()

public UnaryCallSettings<LookupStudyRequest,Study> lookupStudySettings()

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

Returns
Type	Description
UnaryCallSettings<LookupStudyRequest,Study>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

stopTrialSettings()

public UnaryCallSettings<StopTrialRequest,Trial> stopTrialSettings()

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

Returns
Type	Description
UnaryCallSettings<StopTrialRequest,Trial>

suggestTrialsOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<SuggestTrialsRequest,SuggestTrialsResponse,SuggestTrialsMetadata>

suggestTrialsSettings()

public UnaryCallSettings<SuggestTrialsRequest,Operation> suggestTrialsSettings()

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

Returns
Type	Description
UnaryCallSettings<SuggestTrialsRequest,Operation>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public VizierServiceSettings.Builder toBuilder()

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

Returns
Type	Description
VizierServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()