Package com.google.cloud.aiplatform.v1

Class Trial

  • All Implemented Interfaces:
    TrialOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Trial
extends com.google.protobuf.GeneratedMessageV3
implements TrialOrBuilder
     A message representing a Trial. A Trial contains a unique set of Parameters
 that has been or will be evaluated, along with the objective metrics got by
 running the Trial.
    Protobuf type google.cloud.aiplatform.v1.Trial
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. Resource name of the Trial assigned by the service.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface TrialOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Resource name of the Trial assigned by the service.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface TrialOrBuilder
        Returns:
        The bytes for name.

      • getId

        public String getId()
         Output only. The identifier of the Trial assigned by the service.
        string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface TrialOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Output only. The identifier of the Trial assigned by the service.
        string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIdBytes in interface TrialOrBuilder
        Returns:
        The bytes for id.

      • getStateValue

        public int getStateValue()
         Output only. The detailed state of the Trial.
        .google.cloud.aiplatform.v1.Trial.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface TrialOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Trial.State getState()
         Output only. The detailed state of the Trial.
        .google.cloud.aiplatform.v1.Trial.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface TrialOrBuilder
        Returns:
        The state.

      • getParametersList

        public List<Trial.Parameter> getParametersList()
         Output only. The parameters of the Trial.
        repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getParametersList in interface TrialOrBuilder

      • getParametersCount

        public int getParametersCount()
         Output only. The parameters of the Trial.
        repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getParametersCount in interface TrialOrBuilder

      • getParameters

        public Trial.Parameter getParameters​(int index)
         Output only. The parameters of the Trial.
        repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getParameters in interface TrialOrBuilder

      • getParametersOrBuilder

        public Trial.ParameterOrBuilder getParametersOrBuilder​(int index)
         Output only. The parameters of the Trial.
        repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getParametersOrBuilder in interface TrialOrBuilder

      • hasFinalMeasurement

        public boolean hasFinalMeasurement()
         Output only. The final measurement containing the objective value.
        .google.cloud.aiplatform.v1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasFinalMeasurement in interface TrialOrBuilder
        Returns:
        Whether the finalMeasurement field is set.

      • getFinalMeasurement

        public Measurement getFinalMeasurement()
         Output only. The final measurement containing the objective value.
        .google.cloud.aiplatform.v1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getFinalMeasurement in interface TrialOrBuilder
        Returns:
        The finalMeasurement.

      • getFinalMeasurementOrBuilder

        public MeasurementOrBuilder getFinalMeasurementOrBuilder()
         Output only. The final measurement containing the objective value.
        .google.cloud.aiplatform.v1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getFinalMeasurementOrBuilder in interface TrialOrBuilder

      • getMeasurementsList

        public List<Measurement> getMeasurementsList()
         Output only. A list of measurements that are strictly lexicographically
 ordered by their induced tuples (steps, elapsed_duration).
 These are used for early stopping computations.
        repeated .google.cloud.aiplatform.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMeasurementsList in interface TrialOrBuilder

      • getMeasurementsOrBuilderList

        public List<? extends MeasurementOrBuilder> getMeasurementsOrBuilderList()
         Output only. A list of measurements that are strictly lexicographically
 ordered by their induced tuples (steps, elapsed_duration).
 These are used for early stopping computations.
        repeated .google.cloud.aiplatform.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMeasurementsOrBuilderList in interface TrialOrBuilder

      • getMeasurementsCount

        public int getMeasurementsCount()
         Output only. A list of measurements that are strictly lexicographically
 ordered by their induced tuples (steps, elapsed_duration).
 These are used for early stopping computations.
        repeated .google.cloud.aiplatform.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMeasurementsCount in interface TrialOrBuilder

      • getMeasurements

        public Measurement getMeasurements​(int index)
         Output only. A list of measurements that are strictly lexicographically
 ordered by their induced tuples (steps, elapsed_duration).
 These are used for early stopping computations.
        repeated .google.cloud.aiplatform.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMeasurements in interface TrialOrBuilder

      • getMeasurementsOrBuilder

        public MeasurementOrBuilder getMeasurementsOrBuilder​(int index)
         Output only. A list of measurements that are strictly lexicographically
 ordered by their induced tuples (steps, elapsed_duration).
 These are used for early stopping computations.
        repeated .google.cloud.aiplatform.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMeasurementsOrBuilder in interface TrialOrBuilder

      • hasStartTime

        public boolean hasStartTime()
         Output only. Time when the Trial was started.
        .google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasStartTime in interface TrialOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         Output only. Time when the Trial was started.
        .google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTime in interface TrialOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. Time when the Trial was started.
        .google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTimeOrBuilder in interface TrialOrBuilder

      • hasEndTime

        public boolean hasEndTime()
         Output only. Time when the Trial's status changed to `SUCCEEDED` or
 `INFEASIBLE`.
        .google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasEndTime in interface TrialOrBuilder
        Returns:
        Whether the endTime field is set.

      • getEndTime

        public com.google.protobuf.Timestamp getEndTime()
         Output only. Time when the Trial's status changed to `SUCCEEDED` or
 `INFEASIBLE`.
        .google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTime in interface TrialOrBuilder
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         Output only. Time when the Trial's status changed to `SUCCEEDED` or
 `INFEASIBLE`.
        .google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTimeOrBuilder in interface TrialOrBuilder

      • getClientId

        public String getClientId()
         Output only. The identifier of the client that originally requested this
 Trial. Each client is identified by a unique client_id. When a client asks
 for a suggestion, Vertex AI Vizier will assign it a Trial. The client
 should evaluate the Trial, complete it, and report back to Vertex AI
 Vizier. If suggestion is asked again by same client_id before the Trial is
 completed, the same Trial will be returned. Multiple clients with
 different client_ids can ask for suggestions simultaneously, each of them
 will get their own Trial.
        string client_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getClientId in interface TrialOrBuilder
        Returns:
        The clientId.

      • getClientIdBytes

        public com.google.protobuf.ByteString getClientIdBytes()
         Output only. The identifier of the client that originally requested this
 Trial. Each client is identified by a unique client_id. When a client asks
 for a suggestion, Vertex AI Vizier will assign it a Trial. The client
 should evaluate the Trial, complete it, and report back to Vertex AI
 Vizier. If suggestion is asked again by same client_id before the Trial is
 completed, the same Trial will be returned. Multiple clients with
 different client_ids can ask for suggestions simultaneously, each of them
 will get their own Trial.
        string client_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getClientIdBytes in interface TrialOrBuilder
        Returns:
        The bytes for clientId.

      • getInfeasibleReason

        public String getInfeasibleReason()
         Output only. A human readable string describing why the Trial is
 infeasible. This is set only if Trial state is `INFEASIBLE`.
        string infeasible_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getInfeasibleReason in interface TrialOrBuilder
        Returns:
        The infeasibleReason.

      • getInfeasibleReasonBytes

        public com.google.protobuf.ByteString getInfeasibleReasonBytes()
         Output only. A human readable string describing why the Trial is
 infeasible. This is set only if Trial state is `INFEASIBLE`.
        string infeasible_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getInfeasibleReasonBytes in interface TrialOrBuilder
        Returns:
        The bytes for infeasibleReason.

      • getCustomJob

        public String getCustomJob()
         Output only. The CustomJob name linked to the Trial.
 It's set for a HyperparameterTuningJob's Trial.
        string custom_job = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getCustomJob in interface TrialOrBuilder
        Returns:
        The customJob.

      • getCustomJobBytes

        public com.google.protobuf.ByteString getCustomJobBytes()
         Output only. The CustomJob name linked to the Trial.
 It's set for a HyperparameterTuningJob's Trial.
        string custom_job = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getCustomJobBytes in interface TrialOrBuilder
        Returns:
        The bytes for customJob.

      • getWebAccessUrisCount

        public int getWebAccessUrisCount()
        Description copied from interface: TrialOrBuilder
         Output only. URIs for accessing [interactive
 shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 (one URI for each training node). Only available if this trial is part of
 a
 [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob]
 and the job's
 [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
 field is `true`.

 The keys are names of each node used for the trial; for example,
 `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
 the second worker pool, and `workerpool1-1` for the second node in the
 second worker pool.

 The values are the URIs for each node's interactive shell.
        map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getWebAccessUrisCount in interface TrialOrBuilder

      • containsWebAccessUris

        public boolean containsWebAccessUris​(String key)
         Output only. URIs for accessing [interactive
 shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 (one URI for each training node). Only available if this trial is part of
 a
 [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob]
 and the job's
 [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
 field is `true`.

 The keys are names of each node used for the trial; for example,
 `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
 the second worker pool, and `workerpool1-1` for the second node in the
 second worker pool.

 The values are the URIs for each node's interactive shell.
        map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        containsWebAccessUris in interface TrialOrBuilder

      • getWebAccessUrisMap

        public Map<String,​String> getWebAccessUrisMap()
         Output only. URIs for accessing [interactive
 shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 (one URI for each training node). Only available if this trial is part of
 a
 [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob]
 and the job's
 [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
 field is `true`.

 The keys are names of each node used for the trial; for example,
 `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
 the second worker pool, and `workerpool1-1` for the second node in the
 second worker pool.

 The values are the URIs for each node's interactive shell.
        map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getWebAccessUrisMap in interface TrialOrBuilder

      • getWebAccessUrisOrDefault

        public String getWebAccessUrisOrDefault​(String key,
                                        String defaultValue)
         Output only. URIs for accessing [interactive
 shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 (one URI for each training node). Only available if this trial is part of
 a
 [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob]
 and the job's
 [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
 field is `true`.

 The keys are names of each node used for the trial; for example,
 `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
 the second worker pool, and `workerpool1-1` for the second node in the
 second worker pool.

 The values are the URIs for each node's interactive shell.
        map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getWebAccessUrisOrDefault in interface TrialOrBuilder

      • getWebAccessUrisOrThrow

        public String getWebAccessUrisOrThrow​(String key)
         Output only. URIs for accessing [interactive
 shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 (one URI for each training node). Only available if this trial is part of
 a
 [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob]
 and the job's
 [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
 field is `true`.

 The keys are names of each node used for the trial; for example,
 `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
 the second worker pool, and `workerpool1-1` for the second node in the
 second worker pool.

 The values are the URIs for each node's interactive shell.
        map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getWebAccessUrisOrThrow in interface TrialOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Trial parseFrom​(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Trial parseFrom​(ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Trial parseFrom​(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Trial parseFrom​(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Trial parseFrom​(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Trial parseFrom​(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Trial parseFrom​(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Trial.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Trial.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Trial.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Trial getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Trial> parser()

      • getParserForType

        public com.google.protobuf.Parser<Trial> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Trial getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder