Package com.google.cloud.aiplatform.v1beta1

Class VizierServiceSettings

  • @BetaApi
@Generated("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 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();

    • 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.

      • 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.

      • 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.

      • 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.

      • stopTrialSettings

        public com.google.api.gax.rpc.UnaryCallSettings<StopTrialRequest,​Trial> stopTrialSettings()
        Returns the object with the settings used for calls to stopTrial.

      • 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.

      • 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

        @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

      • newBuilder

        public static VizierServiceSettings.Builder newBuilder​(com.google.api.gax.rpc.ClientContext clientContext)
        Returns a new builder for this class.