Class AnnotateTextRequest (2.54.0) 

public final class AnnotateTextRequest extends GeneratedMessageV3 implements AnnotateTextRequestOrBuilder

The request message for the text annotation API, which can perform multiple analysis types in one call.

Protobuf type google.cloud.language.v2.AnnotateTextRequest

Inheritance

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

Static Fields

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
Type Description
int

ENCODING_TYPE_FIELD_NUMBER

public static final int ENCODING_TYPE_FIELD_NUMBER
Field Value
Type Description
int

FEATURES_FIELD_NUMBER

public static final int FEATURES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnnotateTextRequest getDefaultInstance()
Returns
Type Description
AnnotateTextRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AnnotateTextRequest.Builder newBuilder()
Returns
Type Description
AnnotateTextRequest.Builder

newBuilder(AnnotateTextRequest prototype)

public static AnnotateTextRequest.Builder newBuilder(AnnotateTextRequest prototype)
Parameter
Name Description
prototype AnnotateTextRequest
Returns
Type Description
AnnotateTextRequest.Builder

parseDelimitedFrom(InputStream input)

public static AnnotateTextRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotateTextRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateTextRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateTextRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AnnotateTextRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AnnotateTextRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnnotateTextRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateTextRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotateTextRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnnotateTextRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotateTextRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateTextRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotateTextRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnnotateTextRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateTextRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateTextRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AnnotateTextRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotateTextRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateTextRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateTextRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AnnotateTextRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnnotateTextRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotateTextRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateTextRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AnnotateTextRequest> parser()
Returns
Type Description
Parser<AnnotateTextRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public AnnotateTextRequest getDefaultInstanceForType()
Returns
Type Description
AnnotateTextRequest

getDocument()

public Document getDocument()

Required. Input document.

.google.cloud.language.v2.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Document

The document.

getDocumentOrBuilder()

public DocumentOrBuilder getDocumentOrBuilder()

Required. Input document.

.google.cloud.language.v2.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DocumentOrBuilder

getEncodingType()

public EncodingType getEncodingType()

The encoding type used by the API to calculate offsets.

.google.cloud.language.v2.EncodingType encoding_type = 3;

Returns
Type Description
EncodingType

The encodingType.

getEncodingTypeValue()

public int getEncodingTypeValue()

The encoding type used by the API to calculate offsets.

.google.cloud.language.v2.EncodingType encoding_type = 3;

Returns
Type Description
int

The enum numeric value on the wire for encodingType.

getFeatures()

public AnnotateTextRequest.Features getFeatures()

Required. The enabled features.

.google.cloud.language.v2.AnnotateTextRequest.Features features = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AnnotateTextRequest.Features

The features.

getFeaturesOrBuilder()

public AnnotateTextRequest.FeaturesOrBuilder getFeaturesOrBuilder()

Required. The enabled features.

.google.cloud.language.v2.AnnotateTextRequest.Features features = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AnnotateTextRequest.FeaturesOrBuilder

getParserForType()

public Parser<AnnotateTextRequest> getParserForType()
Returns
Type Description
Parser<AnnotateTextRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDocument()

public boolean hasDocument()

Required. Input document.

.google.cloud.language.v2.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the document field is set.

hasFeatures()

public boolean hasFeatures()

Required. The enabled features.

.google.cloud.language.v2.AnnotateTextRequest.Features features = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the features 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 AnnotateTextRequest.Builder newBuilderForType()
Returns
Type Description
AnnotateTextRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotateTextRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AnnotateTextRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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