/*
 * 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.speech.v1p1beta1.model;

/**
 * Specifies the parameters needed for creating a dataset. In addition this is also the message
 * returned to the client by the `CreateDataset` method. It is included in the `result.response`
 * field of the `Operation` returned by the `GetOperation` call of the
 * `google::longrunning::Operations` service.
 *
 * <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 Cloud Speech 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 Dataset extends com.google.api.client.json.GenericJson {

  /**
   * Output only. All the blocking operations associated with this dataset. Like (pre-processing,
   * training-model, testing-model)
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.String> blockingOperationIds;

  /**
   * If set, the log data to be used in this dataset is restricted to the bucket specified. This
   * field is only applicable if use_logged_data is true. If use_logged_data is true, but this field
   * is not set, then all logs will be used for training the models. See: RecognitionMetadata for
   * information on setting up data logs.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String bucketName;

  /**
   * Output only. The timestamp this dataset is created.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String createTime;

  /**
   * Location where the data should be processed. If not specified then we will pick a location on
   * behalf of the user for storing and processing the data. Currently only us-central is supported.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String dataProcessingRegion;

  /**
   * Output only. Stats assoiated with the data.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private DataStats dataStats;

  /**
   * Required. Name of the data set for display.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String displayName;

  /**
   * Output only. True if the data is sufficient to create custom models.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean hasSufficientData;

  /**
   * Required. The language of the supplied audio as a [BCP-47](https://www.rfc-
   * editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](/speech-
   * to-text/docs/languages) for a list of the currently supported language codes.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String languageCode;

  /**
   * All the models (including models pending training) built using the dataset.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<Model> models;

  /**
   * Output only. Resource name of the dataset. Form :-
   * '/projects/{project_number}/locations/{location_id}/datasets/{dataset_id}'
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * Output only. The timestamp this dataset is last updated.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String updateTime;

  /**
   * URI that points to a file in csv file where each row has following format. ,, label can be
   * HUMAN_TRANSCRIBED or MACHINE_TRANSCRIBED. To be valid, rows must do the following: 1. Each row
   * must have at least a label and  2. If a row is marked HUMAN_TRANSCRIBED, then you must specify
   * both  and . Only WAV file formats which encode linear 16-bit pulse-code modulation (PCM) audio
   * format are supported. The maximum audio file size is 50 MB. Also note that the audio has to be
   * single channel audio. 3. There has to be at least 500 rows labelled HUMAN_TRANSCRIBED covering
   * at least ~10K words in order to get reliable word error rate results. 4. To create a language
   * model, you should provide at least 100,000 words in your transcriptions as training data if you
   * have conversational and captions type of data. You should provide at least 10,000 words if you
   * have short utterances like voice commands and search type of use cases. Currently, only Google
   * Cloud Storage URIs are supported, which must be specified in the following format:
   * `gs://bucket_name/object_name` (other URI formats will be ignored). For more information, see
   * [Request URIs](/storage/docs/reference-uris).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String uri;

  /**
   * If this is true, then use the previously logged data (for the project) The logs data for this
   * project will be preprocessed and prepared for downstream pipelines (like training)
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean useLoggedData;

  /**
   * Output only. All the blocking operations associated with this dataset. Like (pre-processing,
   * training-model, testing-model)
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.String> getBlockingOperationIds() {
    return blockingOperationIds;
  }

  /**
   * Output only. All the blocking operations associated with this dataset. Like (pre-processing,
   * training-model, testing-model)
   * @param blockingOperationIds blockingOperationIds or {@code null} for none
   */
  public Dataset setBlockingOperationIds(java.util.List<java.lang.String> blockingOperationIds) {
    this.blockingOperationIds = blockingOperationIds;
    return this;
  }

  /**
   * If set, the log data to be used in this dataset is restricted to the bucket specified. This
   * field is only applicable if use_logged_data is true. If use_logged_data is true, but this field
   * is not set, then all logs will be used for training the models. See: RecognitionMetadata for
   * information on setting up data logs.
   * @return value or {@code null} for none
   */
  public java.lang.String getBucketName() {
    return bucketName;
  }

  /**
   * If set, the log data to be used in this dataset is restricted to the bucket specified. This
   * field is only applicable if use_logged_data is true. If use_logged_data is true, but this field
   * is not set, then all logs will be used for training the models. See: RecognitionMetadata for
   * information on setting up data logs.
   * @param bucketName bucketName or {@code null} for none
   */
  public Dataset setBucketName(java.lang.String bucketName) {
    this.bucketName = bucketName;
    return this;
  }

  /**
   * Output only. The timestamp this dataset is created.
   * @return value or {@code null} for none
   */
  public String getCreateTime() {
    return createTime;
  }

  /**
   * Output only. The timestamp this dataset is created.
   * @param createTime createTime or {@code null} for none
   */
  public Dataset setCreateTime(String createTime) {
    this.createTime = createTime;
    return this;
  }

  /**
   * Location where the data should be processed. If not specified then we will pick a location on
   * behalf of the user for storing and processing the data. Currently only us-central is supported.
   * @return value or {@code null} for none
   */
  public java.lang.String getDataProcessingRegion() {
    return dataProcessingRegion;
  }

  /**
   * Location where the data should be processed. If not specified then we will pick a location on
   * behalf of the user for storing and processing the data. Currently only us-central is supported.
   * @param dataProcessingRegion dataProcessingRegion or {@code null} for none
   */
  public Dataset setDataProcessingRegion(java.lang.String dataProcessingRegion) {
    this.dataProcessingRegion = dataProcessingRegion;
    return this;
  }

  /**
   * Output only. Stats assoiated with the data.
   * @return value or {@code null} for none
   */
  public DataStats getDataStats() {
    return dataStats;
  }

  /**
   * Output only. Stats assoiated with the data.
   * @param dataStats dataStats or {@code null} for none
   */
  public Dataset setDataStats(DataStats dataStats) {
    this.dataStats = dataStats;
    return this;
  }

  /**
   * Required. Name of the data set for display.
   * @return value or {@code null} for none
   */
  public java.lang.String getDisplayName() {
    return displayName;
  }

  /**
   * Required. Name of the data set for display.
   * @param displayName displayName or {@code null} for none
   */
  public Dataset setDisplayName(java.lang.String displayName) {
    this.displayName = displayName;
    return this;
  }

  /**
   * Output only. True if the data is sufficient to create custom models.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getHasSufficientData() {
    return hasSufficientData;
  }

  /**
   * Output only. True if the data is sufficient to create custom models.
   * @param hasSufficientData hasSufficientData or {@code null} for none
   */
  public Dataset setHasSufficientData(java.lang.Boolean hasSufficientData) {
    this.hasSufficientData = hasSufficientData;
    return this;
  }

  /**
   * Required. The language of the supplied audio as a [BCP-47](https://www.rfc-
   * editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](/speech-
   * to-text/docs/languages) for a list of the currently supported language codes.
   * @return value or {@code null} for none
   */
  public java.lang.String getLanguageCode() {
    return languageCode;
  }

  /**
   * Required. The language of the supplied audio as a [BCP-47](https://www.rfc-
   * editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](/speech-
   * to-text/docs/languages) for a list of the currently supported language codes.
   * @param languageCode languageCode or {@code null} for none
   */
  public Dataset setLanguageCode(java.lang.String languageCode) {
    this.languageCode = languageCode;
    return this;
  }

  /**
   * All the models (including models pending training) built using the dataset.
   * @return value or {@code null} for none
   */
  public java.util.List<Model> getModels() {
    return models;
  }

  /**
   * All the models (including models pending training) built using the dataset.
   * @param models models or {@code null} for none
   */
  public Dataset setModels(java.util.List<Model> models) {
    this.models = models;
    return this;
  }

  /**
   * Output only. Resource name of the dataset. Form :-
   * '/projects/{project_number}/locations/{location_id}/datasets/{dataset_id}'
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * Output only. Resource name of the dataset. Form :-
   * '/projects/{project_number}/locations/{location_id}/datasets/{dataset_id}'
   * @param name name or {@code null} for none
   */
  public Dataset setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * Output only. The timestamp this dataset is last updated.
   * @return value or {@code null} for none
   */
  public String getUpdateTime() {
    return updateTime;
  }

  /**
   * Output only. The timestamp this dataset is last updated.
   * @param updateTime updateTime or {@code null} for none
   */
  public Dataset setUpdateTime(String updateTime) {
    this.updateTime = updateTime;
    return this;
  }

  /**
   * URI that points to a file in csv file where each row has following format. ,, label can be
   * HUMAN_TRANSCRIBED or MACHINE_TRANSCRIBED. To be valid, rows must do the following: 1. Each row
   * must have at least a label and  2. If a row is marked HUMAN_TRANSCRIBED, then you must specify
   * both  and . Only WAV file formats which encode linear 16-bit pulse-code modulation (PCM) audio
   * format are supported. The maximum audio file size is 50 MB. Also note that the audio has to be
   * single channel audio. 3. There has to be at least 500 rows labelled HUMAN_TRANSCRIBED covering
   * at least ~10K words in order to get reliable word error rate results. 4. To create a language
   * model, you should provide at least 100,000 words in your transcriptions as training data if you
   * have conversational and captions type of data. You should provide at least 10,000 words if you
   * have short utterances like voice commands and search type of use cases. Currently, only Google
   * Cloud Storage URIs are supported, which must be specified in the following format:
   * `gs://bucket_name/object_name` (other URI formats will be ignored). For more information, see
   * [Request URIs](/storage/docs/reference-uris).
   * @return value or {@code null} for none
   */
  public java.lang.String getUri() {
    return uri;
  }

  /**
   * URI that points to a file in csv file where each row has following format. ,, label can be
   * HUMAN_TRANSCRIBED or MACHINE_TRANSCRIBED. To be valid, rows must do the following: 1. Each row
   * must have at least a label and  2. If a row is marked HUMAN_TRANSCRIBED, then you must specify
   * both  and . Only WAV file formats which encode linear 16-bit pulse-code modulation (PCM) audio
   * format are supported. The maximum audio file size is 50 MB. Also note that the audio has to be
   * single channel audio. 3. There has to be at least 500 rows labelled HUMAN_TRANSCRIBED covering
   * at least ~10K words in order to get reliable word error rate results. 4. To create a language
   * model, you should provide at least 100,000 words in your transcriptions as training data if you
   * have conversational and captions type of data. You should provide at least 10,000 words if you
   * have short utterances like voice commands and search type of use cases. Currently, only Google
   * Cloud Storage URIs are supported, which must be specified in the following format:
   * `gs://bucket_name/object_name` (other URI formats will be ignored). For more information, see
   * [Request URIs](/storage/docs/reference-uris).
   * @param uri uri or {@code null} for none
   */
  public Dataset setUri(java.lang.String uri) {
    this.uri = uri;
    return this;
  }

  /**
   * If this is true, then use the previously logged data (for the project) The logs data for this
   * project will be preprocessed and prepared for downstream pipelines (like training)
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getUseLoggedData() {
    return useLoggedData;
  }

  /**
   * If this is true, then use the previously logged data (for the project) The logs data for this
   * project will be preprocessed and prepared for downstream pipelines (like training)
   * @param useLoggedData useLoggedData or {@code null} for none
   */
  public Dataset setUseLoggedData(java.lang.Boolean useLoggedData) {
    this.useLoggedData = useLoggedData;
    return this;
  }

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

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

}
