Class AnnotateFileResponse (3.40.0)

Version 3.40.0

• 3.41.0 (latest)
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.3
• 2.1.4
• 2.0.29

public final class AnnotateFileResponse extends GeneratedMessageV3 implements AnnotateFileResponseOrBuilder

Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.

Protobuf type google.cloud.vision.v1.AnnotateFileResponse

Inheritance

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

Implements

AnnotateFileResponseOrBuilder

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

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER

Field Value
Type	Description
int

INPUT_CONFIG_FIELD_NUMBER

public static final int INPUT_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

RESPONSES_FIELD_NUMBER

public static final int RESPONSES_FIELD_NUMBER

Field Value
Type	Description
int

TOTAL_PAGES_FIELD_NUMBER

public static final int TOTAL_PAGES_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static AnnotateFileResponse getDefaultInstance()

Returns
Type	Description
AnnotateFileResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static AnnotateFileResponse.Builder newBuilder()

Returns
Type	Description
AnnotateFileResponse.Builder

newBuilder(AnnotateFileResponse prototype)

public static AnnotateFileResponse.Builder newBuilder(AnnotateFileResponse prototype)

Parameter
Name	Description
prototype	AnnotateFileResponse

Returns
Type	Description
AnnotateFileResponse.Builder

parseDelimitedFrom(InputStream input)

public static AnnotateFileResponse parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AnnotateFileResponse

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotateFileResponse

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static AnnotateFileResponse parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
AnnotateFileResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotateFileResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotateFileResponse parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
AnnotateFileResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotateFileResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotateFileResponse parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
AnnotateFileResponse

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotateFileResponse

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static AnnotateFileResponse parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AnnotateFileResponse

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotateFileResponse

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static AnnotateFileResponse parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
AnnotateFileResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotateFileResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<AnnotateFileResponse> parser()

Returns
Type	Description
Parser<AnnotateFileResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public AnnotateFileResponse getDefaultInstanceForType()

Returns
Type	Description
AnnotateFileResponse

getError()

public Status getError()

If set, represents the error message for the failed request. The responses field will not be set in this case.

.google.rpc.Status error = 4;

Returns
Type	Description
com.google.rpc.Status	The error.

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

If set, represents the error message for the failed request. The responses field will not be set in this case.

.google.rpc.Status error = 4;

Returns
Type	Description
com.google.rpc.StatusOrBuilder

getInputConfig()

public InputConfig getInputConfig()

Information about the file for which this response is generated.

.google.cloud.vision.v1.InputConfig input_config = 1;

Returns
Type	Description
InputConfig	The inputConfig.

getInputConfigOrBuilder()

public InputConfigOrBuilder getInputConfigOrBuilder()

Information about the file for which this response is generated.

.google.cloud.vision.v1.InputConfig input_config = 1;

Returns
Type	Description
InputConfigOrBuilder

getParserForType()

public Parser<AnnotateFileResponse> getParserForType()

Returns
Type	Description
Parser<AnnotateFileResponse>

Overrides

GeneratedMessageV3.getParserForType()

getResponses(int index)

public AnnotateImageResponse getResponses(int index)

Individual responses to images found within the file. This field will be empty if the error field is set.

repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
AnnotateImageResponse

getResponsesCount()

public int getResponsesCount()

Individual responses to images found within the file. This field will be empty if the error field is set.

repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 2;

Returns
Type	Description
int

getResponsesList()

public List<AnnotateImageResponse> getResponsesList()

Individual responses to images found within the file. This field will be empty if the error field is set.

repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 2;

Returns
Type	Description
List<AnnotateImageResponse>

getResponsesOrBuilder(int index)

public AnnotateImageResponseOrBuilder getResponsesOrBuilder(int index)

Individual responses to images found within the file. This field will be empty if the error field is set.

repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
AnnotateImageResponseOrBuilder

getResponsesOrBuilderList()

public List<? extends AnnotateImageResponseOrBuilder> getResponsesOrBuilderList()

Individual responses to images found within the file. This field will be empty if the error field is set.

repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 2;

Returns
Type	Description
List<? extends com.google.cloud.vision.v1.AnnotateImageResponseOrBuilder>

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getTotalPages()

public int getTotalPages()

This field gives the total number of pages in the file.

int32 total_pages = 3;

Returns
Type	Description
int	The totalPages.

hasError()

public boolean hasError()

If set, represents the error message for the failed request. The responses field will not be set in this case.

.google.rpc.Status error = 4;

Returns
Type	Description
boolean	Whether the error field is set.

hasInputConfig()

public boolean hasInputConfig()

Information about the file for which this response is generated.

.google.cloud.vision.v1.InputConfig input_config = 1;

Returns
Type	Description
boolean	Whether the inputConfig 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 AnnotateFileResponse.Builder newBuilderForType()

Returns
Type	Description
AnnotateFileResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotateFileResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
AnnotateFileResponse.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 AnnotateFileResponse.Builder toBuilder()

Returns
Type	Description
AnnotateFileResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException