Package com.google.cloud.aiplatform.v1

Interface TrialOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Trial, Trial.Builder
@Generated public interface TrialOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

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

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getId

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

    • getIdBytes

      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];
      Returns:
      The bytes for id.

    • getStateValue

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

    • getState

      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];
      Returns:
      The state.

    • getParametersList

      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];

    • getParameters

      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];

    • getParametersCount

      int getParametersCount()
       Output only. The parameters of the Trial.
      repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getParametersOrBuilderList

      List<? extends Trial.ParameterOrBuilder> getParametersOrBuilderList()
       Output only. The parameters of the Trial.
      repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getParametersOrBuilder

      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];

    • hasFinalMeasurement

      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];
      Returns:
      Whether the finalMeasurement field is set.

    • getFinalMeasurement

      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];
      Returns:
      The finalMeasurement.

    • getFinalMeasurementOrBuilder

      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];

    • getMeasurementsList

      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];

    • getMeasurements

      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];

    • getMeasurementsCount

      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];

    • getMeasurementsOrBuilderList

      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];

    • getMeasurementsOrBuilder

      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];

    • hasStartTime

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

    • getStartTime

      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];
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      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];

    • hasEndTime

      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];
      Returns:
      Whether the endTime field is set.

    • getEndTime

      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];
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      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];

    • getClientId

      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];
      Returns:
      The clientId.

    • getClientIdBytes

      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];
      Returns:
      The bytes for clientId.

    • getInfeasibleReason

      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];
      Returns:
      The infeasibleReason.

    • getInfeasibleReasonBytes

      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];
      Returns:
      The bytes for infeasibleReason.

    • getCustomJob

      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) = { ... }
      Returns:
      The customJob.

    • getCustomJobBytes

      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) = { ... }
      Returns:
      The bytes for customJob.

    • getWebAccessUrisCount

      int getWebAccessUrisCount()
       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];

    • containsWebAccessUris

      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];

    • getWebAccessUris

      @Deprecated Map<String,String> getWebAccessUris()
      Deprecated.
      Use getWebAccessUrisMap() instead.

    • getWebAccessUrisMap

      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];

    • getWebAccessUrisOrDefault

      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];

    • getWebAccessUrisOrThrow

      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];