/*
 * 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;

/**
 * Training Dataset information.
 *
 * <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 GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset extends com.google.api.client.json.GenericJson {

  /**
   * The BigQuery table of the unmanaged Dataset used to train this Model.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudAiplatformV1BigQuerySource bigquerySource;

  /**
   * Data format of the dataset, only applicable if the input is from Google Cloud Storage. The
   * possible formats are: "tf-record" The source file is a TFRecord file. "csv" The source file is
   * a CSV file. "jsonl" The source file is a JSONL file.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String dataFormat;

  /**
   * The resource name of the Dataset used to train this Model.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String dataset;

  /**
   * The Google Cloud Storage uri of the unmanaged Dataset used to train this Model.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudAiplatformV1GcsSource gcsSource;

  /**
   * Strategy to sample data from Training Dataset. If not set, we process the whole dataset.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudAiplatformV1SamplingStrategy loggingSamplingStrategy;

  /**
   * The target field name the model is to predict. This field will be excluded when doing Predict
   * and (or) Explain for the training data.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String targetField;

  /**
   * The BigQuery table of the unmanaged Dataset used to train this Model.
   * @return value or {@code null} for none
   */
  public GoogleCloudAiplatformV1BigQuerySource getBigquerySource() {
    return bigquerySource;
  }

  /**
   * The BigQuery table of the unmanaged Dataset used to train this Model.
   * @param bigquerySource bigquerySource or {@code null} for none
   */
  public GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset setBigquerySource(GoogleCloudAiplatformV1BigQuerySource bigquerySource) {
    this.bigquerySource = bigquerySource;
    return this;
  }

  /**
   * Data format of the dataset, only applicable if the input is from Google Cloud Storage. The
   * possible formats are: "tf-record" The source file is a TFRecord file. "csv" The source file is
   * a CSV file. "jsonl" The source file is a JSONL file.
   * @return value or {@code null} for none
   */
  public java.lang.String getDataFormat() {
    return dataFormat;
  }

  /**
   * Data format of the dataset, only applicable if the input is from Google Cloud Storage. The
   * possible formats are: "tf-record" The source file is a TFRecord file. "csv" The source file is
   * a CSV file. "jsonl" The source file is a JSONL file.
   * @param dataFormat dataFormat or {@code null} for none
   */
  public GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset setDataFormat(java.lang.String dataFormat) {
    this.dataFormat = dataFormat;
    return this;
  }

  /**
   * The resource name of the Dataset used to train this Model.
   * @return value or {@code null} for none
   */
  public java.lang.String getDataset() {
    return dataset;
  }

  /**
   * The resource name of the Dataset used to train this Model.
   * @param dataset dataset or {@code null} for none
   */
  public GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset setDataset(java.lang.String dataset) {
    this.dataset = dataset;
    return this;
  }

  /**
   * The Google Cloud Storage uri of the unmanaged Dataset used to train this Model.
   * @return value or {@code null} for none
   */
  public GoogleCloudAiplatformV1GcsSource getGcsSource() {
    return gcsSource;
  }

  /**
   * The Google Cloud Storage uri of the unmanaged Dataset used to train this Model.
   * @param gcsSource gcsSource or {@code null} for none
   */
  public GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset setGcsSource(GoogleCloudAiplatformV1GcsSource gcsSource) {
    this.gcsSource = gcsSource;
    return this;
  }

  /**
   * Strategy to sample data from Training Dataset. If not set, we process the whole dataset.
   * @return value or {@code null} for none
   */
  public GoogleCloudAiplatformV1SamplingStrategy getLoggingSamplingStrategy() {
    return loggingSamplingStrategy;
  }

  /**
   * Strategy to sample data from Training Dataset. If not set, we process the whole dataset.
   * @param loggingSamplingStrategy loggingSamplingStrategy or {@code null} for none
   */
  public GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset setLoggingSamplingStrategy(GoogleCloudAiplatformV1SamplingStrategy loggingSamplingStrategy) {
    this.loggingSamplingStrategy = loggingSamplingStrategy;
    return this;
  }

  /**
   * The target field name the model is to predict. This field will be excluded when doing Predict
   * and (or) Explain for the training data.
   * @return value or {@code null} for none
   */
  public java.lang.String getTargetField() {
    return targetField;
  }

  /**
   * The target field name the model is to predict. This field will be excluded when doing Predict
   * and (or) Explain for the training data.
   * @param targetField targetField or {@code null} for none
   */
  public GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset setTargetField(java.lang.String targetField) {
    this.targetField = targetField;
    return this;
  }

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

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

}
