com.google.api.services.language.v1.model.AnnotateTextResponse Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2010 Google Inc.
 *
 * 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://code.google.com/p/google-apis-client-generator/
 * (build: 2017-01-11 18:31:16 UTC)
 * on 2017-01-25 at 09:42:44 UTC 
 * Modify at your own risk.
 */

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

/**
 * The text annotations response message.
 *
 *  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 Google Cloud Natural Language API. For a detailed
 * explanation see:
 * http://code.google.com/p/google-http-java-client/wiki/JSON
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class AnnotateTextResponse extends com.google.api.client.json.GenericJson {

  /**
   * The overall sentiment for the document. Populated if the user enables
   * AnnotateTextRequest.Features.extract_document_sentiment.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Sentiment documentSentiment;

  /**
   * Entities, along with their semantic information, in the input document. Populated if the user
   * enables AnnotateTextRequest.Features.extract_entities.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List entities;

  static {
    // hack to force ProGuard to consider Entity used, since otherwise it would be stripped out
    // see http://code.google.com/p/google-api-java-client/issues/detail?id=528
    com.google.api.client.util.Data.nullOf(Entity.class);
  }

  /**
   * The language of the text, which will be the same as the language specified in the request or,
   * if not specified, the automatically-detected language. See `Document.language` field for more
   * details.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String language;

  /**
   * Sentences in the input document. Populated if the user enables
   * AnnotateTextRequest.Features.extract_syntax.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List sentences;

  static {
    // hack to force ProGuard to consider Sentence used, since otherwise it would be stripped out
    // see http://code.google.com/p/google-api-java-client/issues/detail?id=528
    com.google.api.client.util.Data.nullOf(Sentence.class);
  }

  /**
   * Tokens, along with their syntactic information, in the input document. Populated if the user
   * enables AnnotateTextRequest.Features.extract_syntax.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List tokens;

  /**
   * The overall sentiment for the document. Populated if the user enables
   * AnnotateTextRequest.Features.extract_document_sentiment.
   * @return value or {@code null} for none
   */
  public Sentiment getDocumentSentiment() {
    return documentSentiment;
  }

  /**
   * The overall sentiment for the document. Populated if the user enables
   * AnnotateTextRequest.Features.extract_document_sentiment.
   * @param documentSentiment documentSentiment or {@code null} for none
   */
  public AnnotateTextResponse setDocumentSentiment(Sentiment documentSentiment) {
    this.documentSentiment = documentSentiment;
    return this;
  }

  /**
   * Entities, along with their semantic information, in the input document. Populated if the user
   * enables AnnotateTextRequest.Features.extract_entities.
   * @return value or {@code null} for none
   */
  public java.util.List getEntities() {
    return entities;
  }

  /**
   * Entities, along with their semantic information, in the input document. Populated if the user
   * enables AnnotateTextRequest.Features.extract_entities.
   * @param entities entities or {@code null} for none
   */
  public AnnotateTextResponse setEntities(java.util.List entities) {
    this.entities = entities;
    return this;
  }

  /**
   * The language of the text, which will be the same as the language specified in the request or,
   * if not specified, the automatically-detected language. See `Document.language` field for more
   * details.
   * @return value or {@code null} for none
   */
  public java.lang.String getLanguage() {
    return language;
  }

  /**
   * The language of the text, which will be the same as the language specified in the request or,
   * if not specified, the automatically-detected language. See `Document.language` field for more
   * details.
   * @param language language or {@code null} for none
   */
  public AnnotateTextResponse setLanguage(java.lang.String language) {
    this.language = language;
    return this;
  }

  /**
   * Sentences in the input document. Populated if the user enables
   * AnnotateTextRequest.Features.extract_syntax.
   * @return value or {@code null} for none
   */
  public java.util.List getSentences() {
    return sentences;
  }

  /**
   * Sentences in the input document. Populated if the user enables
   * AnnotateTextRequest.Features.extract_syntax.
   * @param sentences sentences or {@code null} for none
   */
  public AnnotateTextResponse setSentences(java.util.List sentences) {
    this.sentences = sentences;
    return this;
  }

  /**
   * Tokens, along with their syntactic information, in the input document. Populated if the user
   * enables AnnotateTextRequest.Features.extract_syntax.
   * @return value or {@code null} for none
   */
  public java.util.List getTokens() {
    return tokens;
  }

  /**
   * Tokens, along with their syntactic information, in the input document. Populated if the user
   * enables AnnotateTextRequest.Features.extract_syntax.
   * @param tokens tokens or {@code null} for none
   */
  public AnnotateTextResponse setTokens(java.util.List tokens) {
    this.tokens = tokens;
    return this;
  }

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

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

}