/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.aiplatform.v1.model;

/**
 * The median automated stopping rule stops a pending Trial if the Trial's best objective_value is
 * strictly below the median 'performance' of all completed Trials reported up to the Trial's last
 * measurement. Currently, 'performance' refers to the running average of the objective values
 * reported by the Trial in each measurement.
 *
 * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Vertex AI API. For a detailed explanation see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec extends com.google.api.client.json.GenericJson {

  /**
   * True if median automated stopping rule applies on Measurement.elapsed_duration. It means that
   * elapsed_duration field of latest measurement of current Trial is used to compute median
   * objective value for each completed Trials.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean useElapsedDuration;

  /**
   * True if median automated stopping rule applies on Measurement.elapsed_duration. It means that
   * elapsed_duration field of latest measurement of current Trial is used to compute median
   * objective value for each completed Trials.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getUseElapsedDuration() {
    return useElapsedDuration;
  }

  /**
   * True if median automated stopping rule applies on Measurement.elapsed_duration. It means that
   * elapsed_duration field of latest measurement of current Trial is used to compute median
   * objective value for each completed Trials.
   * @param useElapsedDuration useElapsedDuration or {@code null} for none
   */
  public GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec setUseElapsedDuration(java.lang.Boolean useElapsedDuration) {
    this.useElapsedDuration = useElapsedDuration;
    return this;
  }

  @Override
  public GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec set(String fieldName, Object value) {
    return (GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec) super.set(fieldName, value);
  }

  @Override
  public GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec clone() {
    return (GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec) super.clone();
  }

}
