Class AnnotateTextResponse (2.45.0)

Version 2.45.0

• 2.54.0 (latest)
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.1
• 2.3.4
• 2.2.0
• 2.1.10

public final class AnnotateTextResponse extends GeneratedMessageV3 implements AnnotateTextResponseOrBuilder

The text annotations response message.

Protobuf type google.cloud.language.v2.AnnotateTextResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AnnotateTextResponse

Implements

AnnotateTextResponseOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CATEGORIES_FIELD_NUMBER

public static final int CATEGORIES_FIELD_NUMBER

Field Value
Type	Description
int

DOCUMENT_SENTIMENT_FIELD_NUMBER

public static final int DOCUMENT_SENTIMENT_FIELD_NUMBER

Field Value
Type	Description
int

ENTITIES_FIELD_NUMBER

public static final int ENTITIES_FIELD_NUMBER

Field Value
Type	Description
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER

Field Value
Type	Description
int

LANGUAGE_SUPPORTED_FIELD_NUMBER

public static final int LANGUAGE_SUPPORTED_FIELD_NUMBER

Field Value
Type	Description
int

MODERATION_CATEGORIES_FIELD_NUMBER

public static final int MODERATION_CATEGORIES_FIELD_NUMBER

Field Value
Type	Description
int

SENTENCES_FIELD_NUMBER

public static final int SENTENCES_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static AnnotateTextResponse getDefaultInstance()

Returns
Type	Description
AnnotateTextResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static AnnotateTextResponse.Builder newBuilder()

Returns
Type	Description
AnnotateTextResponse.Builder

newBuilder(AnnotateTextResponse prototype)

public static AnnotateTextResponse.Builder newBuilder(AnnotateTextResponse prototype)

Parameter
Name	Description
prototype	AnnotateTextResponse

Returns
Type	Description
AnnotateTextResponse.Builder

parseDelimitedFrom(InputStream input)

public static AnnotateTextResponse parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AnnotateTextResponse

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateTextResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotateTextResponse

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static AnnotateTextResponse parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
AnnotateTextResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnnotateTextResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotateTextResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotateTextResponse parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
AnnotateTextResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotateTextResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotateTextResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotateTextResponse parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
AnnotateTextResponse

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateTextResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotateTextResponse

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static AnnotateTextResponse parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AnnotateTextResponse

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateTextResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotateTextResponse

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static AnnotateTextResponse parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
AnnotateTextResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotateTextResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotateTextResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<AnnotateTextResponse> parser()

Returns
Type	Description
Parser<AnnotateTextResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getCategories(int index)

public ClassificationCategory getCategories(int index)

Categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory categories = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
ClassificationCategory

getCategoriesCount()

public int getCategoriesCount()

Categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory categories = 5;

Returns
Type	Description
int

getCategoriesList()

public List<ClassificationCategory> getCategoriesList()

Categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory categories = 5;

Returns
Type	Description
List<ClassificationCategory>

getCategoriesOrBuilder(int index)

public ClassificationCategoryOrBuilder getCategoriesOrBuilder(int index)

Categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory categories = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
ClassificationCategoryOrBuilder

getCategoriesOrBuilderList()

public List<? extends ClassificationCategoryOrBuilder> getCategoriesOrBuilderList()

Categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory categories = 5;

Returns
Type	Description
List<? extends com.google.cloud.language.v2.ClassificationCategoryOrBuilder>

getDefaultInstanceForType()

public AnnotateTextResponse getDefaultInstanceForType()

Returns
Type	Description
AnnotateTextResponse

getDocumentSentiment()

public Sentiment getDocumentSentiment()

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

.google.cloud.language.v2.Sentiment document_sentiment = 3;

Returns
Type	Description
Sentiment	The documentSentiment.

getDocumentSentimentOrBuilder()

public SentimentOrBuilder getDocumentSentimentOrBuilder()

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

.google.cloud.language.v2.Sentiment document_sentiment = 3;

Returns
Type	Description
SentimentOrBuilder

getEntities(int index)

public Entity getEntities(int index)

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

repeated .google.cloud.language.v2.Entity entities = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Entity

getEntitiesCount()

public int getEntitiesCount()

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

repeated .google.cloud.language.v2.Entity entities = 2;

Returns
Type	Description
int

getEntitiesList()

public List<Entity> getEntitiesList()

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

repeated .google.cloud.language.v2.Entity entities = 2;

Returns
Type	Description
List<Entity>

getEntitiesOrBuilder(int index)

public EntityOrBuilder getEntitiesOrBuilder(int index)

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

repeated .google.cloud.language.v2.Entity entities = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
EntityOrBuilder

getEntitiesOrBuilderList()

public List<? extends EntityOrBuilder> getEntitiesOrBuilderList()

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

repeated .google.cloud.language.v2.Entity entities = 2;

Returns
Type	Description
List<? extends com.google.cloud.language.v2.EntityOrBuilder>

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

string language_code = 4;

Returns
Type	Description
String	The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

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.

string language_code = 4;

Returns
Type	Description
ByteString	The bytes for languageCode.

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.

bool language_supported = 7;

Returns
Type	Description
boolean	The languageSupported.

getModerationCategories(int index)

public ClassificationCategory getModerationCategories(int index)

Harmful and sensitive categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory moderation_categories = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
ClassificationCategory

getModerationCategoriesCount()

public int getModerationCategoriesCount()

Harmful and sensitive categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory moderation_categories = 6;

Returns
Type	Description
int

getModerationCategoriesList()

public List<ClassificationCategory> getModerationCategoriesList()

Harmful and sensitive categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory moderation_categories = 6;

Returns
Type	Description
List<ClassificationCategory>

getModerationCategoriesOrBuilder(int index)

public ClassificationCategoryOrBuilder getModerationCategoriesOrBuilder(int index)

Harmful and sensitive categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory moderation_categories = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
ClassificationCategoryOrBuilder

getModerationCategoriesOrBuilderList()

public List<? extends ClassificationCategoryOrBuilder> getModerationCategoriesOrBuilderList()

Harmful and sensitive categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory moderation_categories = 6;

Returns
Type	Description
List<? extends com.google.cloud.language.v2.ClassificationCategoryOrBuilder>

getParserForType()

public Parser<AnnotateTextResponse> getParserForType()

Returns
Type	Description
Parser<AnnotateTextResponse>

Overrides

GeneratedMessageV3.getParserForType()

getSentences(int index)

public Sentence getSentences(int index)

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

repeated .google.cloud.language.v2.Sentence sentences = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Sentence

getSentencesCount()

public int getSentencesCount()

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

repeated .google.cloud.language.v2.Sentence sentences = 1;

Returns
Type	Description
int

getSentencesList()

public List<Sentence> getSentencesList()

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

repeated .google.cloud.language.v2.Sentence sentences = 1;

Returns
Type	Description
List<Sentence>

getSentencesOrBuilder(int index)

public SentenceOrBuilder getSentencesOrBuilder(int index)

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

repeated .google.cloud.language.v2.Sentence sentences = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
SentenceOrBuilder

getSentencesOrBuilderList()

public List<? extends SentenceOrBuilder> getSentencesOrBuilderList()

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

repeated .google.cloud.language.v2.Sentence sentences = 1;

Returns
Type	Description
List<? extends com.google.cloud.language.v2.SentenceOrBuilder>

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hasDocumentSentiment()

public boolean hasDocumentSentiment()

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

.google.cloud.language.v2.Sentiment document_sentiment = 3;

Returns
Type	Description
boolean	Whether the documentSentiment field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public AnnotateTextResponse.Builder newBuilderForType()

Returns
Type	Description
AnnotateTextResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotateTextResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
AnnotateTextResponse.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public AnnotateTextResponse.Builder toBuilder()

Returns
Type	Description
AnnotateTextResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException