/*
 * 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.contentwarehouse.v1.model;

/**
 * Information for chosen snippet. Next ID: 8
 *
 * <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 Document AI Warehouse 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 QualityPreviewChosenSnippetInfo extends com.google.api.client.json.GenericJson {

  /**
   * Whether this snippet is a vulgar candidate.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean isVulgar;

  /**
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String leadingTextType;

  /**
   * The rendered snippet html.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String snippetHtml;

  /**
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String snippetType;

  /**
   * Source of the chosen snippet, decided in PORC. String value of
   * quality.porc.TextSnippetCandidate.TextSnippetSource defined at
   * google3/quality/porc/proto/text_snippet.proto
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String source;

  /**
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<QualityPreviewChosenSnippetInfoTidbitInfo> tidbits;

  /**
   * Whether this snippet has trailing ellipsis.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean trailingEllipsis;

  /**
   * Whether this snippet is a vulgar candidate.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getIsVulgar() {
    return isVulgar;
  }

  /**
   * Whether this snippet is a vulgar candidate.
   * @param isVulgar isVulgar or {@code null} for none
   */
  public QualityPreviewChosenSnippetInfo setIsVulgar(java.lang.Boolean isVulgar) {
    this.isVulgar = isVulgar;
    return this;
  }

  /**
   * @return value or {@code null} for none
   */
  public java.lang.String getLeadingTextType() {
    return leadingTextType;
  }

  /**
   * @param leadingTextType leadingTextType or {@code null} for none
   */
  public QualityPreviewChosenSnippetInfo setLeadingTextType(java.lang.String leadingTextType) {
    this.leadingTextType = leadingTextType;
    return this;
  }

  /**
   * The rendered snippet html.
   * @return value or {@code null} for none
   */
  public java.lang.String getSnippetHtml() {
    return snippetHtml;
  }

  /**
   * The rendered snippet html.
   * @param snippetHtml snippetHtml or {@code null} for none
   */
  public QualityPreviewChosenSnippetInfo setSnippetHtml(java.lang.String snippetHtml) {
    this.snippetHtml = snippetHtml;
    return this;
  }

  /**
   * @return value or {@code null} for none
   */
  public java.lang.String getSnippetType() {
    return snippetType;
  }

  /**
   * @param snippetType snippetType or {@code null} for none
   */
  public QualityPreviewChosenSnippetInfo setSnippetType(java.lang.String snippetType) {
    this.snippetType = snippetType;
    return this;
  }

  /**
   * Source of the chosen snippet, decided in PORC. String value of
   * quality.porc.TextSnippetCandidate.TextSnippetSource defined at
   * google3/quality/porc/proto/text_snippet.proto
   * @return value or {@code null} for none
   */
  public java.lang.String getSource() {
    return source;
  }

  /**
   * Source of the chosen snippet, decided in PORC. String value of
   * quality.porc.TextSnippetCandidate.TextSnippetSource defined at
   * google3/quality/porc/proto/text_snippet.proto
   * @param source source or {@code null} for none
   */
  public QualityPreviewChosenSnippetInfo setSource(java.lang.String source) {
    this.source = source;
    return this;
  }

  /**
   * @return value or {@code null} for none
   */
  public java.util.List<QualityPreviewChosenSnippetInfoTidbitInfo> getTidbits() {
    return tidbits;
  }

  /**
   * @param tidbits tidbits or {@code null} for none
   */
  public QualityPreviewChosenSnippetInfo setTidbits(java.util.List<QualityPreviewChosenSnippetInfoTidbitInfo> tidbits) {
    this.tidbits = tidbits;
    return this;
  }

  /**
   * Whether this snippet has trailing ellipsis.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getTrailingEllipsis() {
    return trailingEllipsis;
  }

  /**
   * Whether this snippet has trailing ellipsis.
   * @param trailingEllipsis trailingEllipsis or {@code null} for none
   */
  public QualityPreviewChosenSnippetInfo setTrailingEllipsis(java.lang.Boolean trailingEllipsis) {
    this.trailingEllipsis = trailingEllipsis;
    return this;
  }

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

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

}
