/*
 * 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.texttospeech.v1beta1.model;

/**
 * Description of a voice supported by the TTS 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 Text-to-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 Voice extends com.google.api.client.json.GenericJson {

  /**
   * The languages that this voice supports, expressed as [BCP-47](https://www.rfc-
   * editor.org/rfc/bcp/bcp47.txt) language tags (e.g. "en-US", "es-419", "cmn-tw").
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.String> languageCodes;

  /**
   * The name of this voice.  Each distinct voice has a unique name.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * The natural sample rate (in hertz) for this voice.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer naturalSampleRateHertz;

  /**
   * The gender of this voice.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String ssmlGender;

  /**
   * The languages that this voice supports, expressed as [BCP-47](https://www.rfc-
   * editor.org/rfc/bcp/bcp47.txt) language tags (e.g. "en-US", "es-419", "cmn-tw").
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.String> getLanguageCodes() {
    return languageCodes;
  }

  /**
   * The languages that this voice supports, expressed as [BCP-47](https://www.rfc-
   * editor.org/rfc/bcp/bcp47.txt) language tags (e.g. "en-US", "es-419", "cmn-tw").
   * @param languageCodes languageCodes or {@code null} for none
   */
  public Voice setLanguageCodes(java.util.List<java.lang.String> languageCodes) {
    this.languageCodes = languageCodes;
    return this;
  }

  /**
   * The name of this voice.  Each distinct voice has a unique name.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * The name of this voice.  Each distinct voice has a unique name.
   * @param name name or {@code null} for none
   */
  public Voice setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * The natural sample rate (in hertz) for this voice.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getNaturalSampleRateHertz() {
    return naturalSampleRateHertz;
  }

  /**
   * The natural sample rate (in hertz) for this voice.
   * @param naturalSampleRateHertz naturalSampleRateHertz or {@code null} for none
   */
  public Voice setNaturalSampleRateHertz(java.lang.Integer naturalSampleRateHertz) {
    this.naturalSampleRateHertz = naturalSampleRateHertz;
    return this;
  }

  /**
   * The gender of this voice.
   * @return value or {@code null} for none
   */
  public java.lang.String getSsmlGender() {
    return ssmlGender;
  }

  /**
   * The gender of this voice.
   * @param ssmlGender ssmlGender or {@code null} for none
   */
  public Voice setSsmlGender(java.lang.String ssmlGender) {
    this.ssmlGender = ssmlGender;
    return this;
  }

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

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

}
