Class AnnotateTextResponse (2.48.0)

public final class AnnotateTextResponse extends GeneratedMessageV3 implements AnnotateTextResponseOrBuilder

The text annotations response message.

Protobuf type google.cloud.language.v2.AnnotateTextResponse

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

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

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AnnotateTextResponse.Builder toBuilder()
Returns
Type Description
AnnotateTextResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException