com.google.api.services.language.v2.model

Class AnnotateTextResponse

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.language.v2.model.AnnotateTextResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AnnotateTextResponse
extends com.google.api.client.json.GenericJson

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 Cloud Natural Language API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AnnotateTextResponse()

Method Summary

Modifier and Type	Method and Description
AnnotateTextResponse	clone()
List<ClassificationCategory>	getCategories() Categories identified in the input document.
Sentiment	getDocumentSentiment() The overall sentiment for the document.
List<Entity>	getEntities() Entities, along with their semantic information, in the input document.
String	getLanguageCode() 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.
Boolean	getLanguageSupported() Whether the language is officially supported by all requested features.
List<ClassificationCategory>	getModerationCategories() Harmful and sensitive categories identified in the input document.
List<Sentence>	getSentences() Sentences in the input document.
AnnotateTextResponse	set(String fieldName, Object value)
AnnotateTextResponse	setCategories(List<ClassificationCategory> categories) Categories identified in the input document.
AnnotateTextResponse	setDocumentSentiment(Sentiment documentSentiment) The overall sentiment for the document.
AnnotateTextResponse	setEntities(List<Entity> entities) Entities, along with their semantic information, in the input document.
AnnotateTextResponse	setLanguageCode(String languageCode) 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.
AnnotateTextResponse	setLanguageSupported(Boolean languageSupported) Whether the language is officially supported by all requested features.
AnnotateTextResponse	setModerationCategories(List<ClassificationCategory> moderationCategories) Harmful and sensitive categories identified in the input document.
AnnotateTextResponse	setSentences(List<Sentence> sentences) Sentences in the input document.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

AnnotateTextResponse

public AnnotateTextResponse()

Method Detail

getCategories

public List<ClassificationCategory> getCategories()

Categories identified in the input document.

Returns:

value or null for none

setCategories

public AnnotateTextResponse setCategories(List<ClassificationCategory> categories)

Categories identified in the input document.

Parameters:

categories - categories or null for none

getDocumentSentiment

public Sentiment getDocumentSentiment()

The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

Returns:

value or null for none

setDocumentSentiment

public AnnotateTextResponse setDocumentSentiment(Sentiment documentSentiment)

The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

Parameters:

documentSentiment - documentSentiment or null for none

getEntities

public List<Entity> getEntities()

Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities .

Returns:

value or null for none

setEntities

public AnnotateTextResponse setEntities(List<Entity> entities)

Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities .

Parameters:

entities - entities or null for none

getLanguageCode

public String getLanguageCode()

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_code field for more details.

Returns:

value or null for none

setLanguageCode

public AnnotateTextResponse setLanguageCode(String languageCode)

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_code field for more details.

Parameters:

languageCode - languageCode or null for none

getLanguageSupported

public Boolean getLanguageSupported()

Whether the language is officially supported by all requested features. The API may still return a response when the language is not supported, but it is on a best effort basis.

Returns:

value or null for none

setLanguageSupported

public AnnotateTextResponse setLanguageSupported(Boolean languageSupported)

Whether the language is officially supported by all requested features. The API may still return a response when the language is not supported, but it is on a best effort basis.

Parameters:

languageSupported - languageSupported or null for none

getModerationCategories

public List<ClassificationCategory> getModerationCategories()

Harmful and sensitive categories identified in the input document.

Returns:

value or null for none

setModerationCategories

public AnnotateTextResponse setModerationCategories(List<ClassificationCategory> moderationCategories)

Harmful and sensitive categories identified in the input document.

Parameters:

moderationCategories - moderationCategories or null for none

getSentences

public List<Sentence> getSentences()

Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

Returns:

value or null for none

setSentences

public AnnotateTextResponse setSentences(List<Sentence> sentences)

Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

Parameters:

sentences - sentences or null for none

set

public AnnotateTextResponse set(String fieldName,
                                Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public AnnotateTextResponse clone()

Overrides:

clone in class com.google.api.client.json.GenericJson