Class AnnotateFileResponse (3.40.0)
Version 3.40.0keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static AnnotateFileResponse . Builder newBuilder ()
newBuilder(AnnotateFileResponse prototype)
public static AnnotateFileResponse . Builder newBuilder ( AnnotateFileResponse prototype )
public static AnnotateFileResponse parseDelimitedFrom ( InputStream input )
public static AnnotateFileResponse parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static AnnotateFileResponse parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AnnotateFileResponse parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static AnnotateFileResponse parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AnnotateFileResponse parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static AnnotateFileResponse parseFrom ( CodedInputStream input )
public static AnnotateFileResponse parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static AnnotateFileResponse parseFrom ( InputStream input )
public static AnnotateFileResponse parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static AnnotateFileResponse parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AnnotateFileResponse parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<AnnotateFileResponse> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public AnnotateFileResponse getDefaultInstanceForType ()
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
public InputConfig getInputConfig ()
Information about the file for which this response is generated.
.google.cloud.vision.v1.InputConfig input_config = 1;
public InputConfigOrBuilder getInputConfigOrBuilder ()
Information about the file for which this response is generated.
.google.cloud.vision.v1.InputConfig input_config = 1;
getParserForType()
public Parser<AnnotateFileResponse> getParserForType ()
Overrides
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
indexint
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;
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
indexint
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
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.
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()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public AnnotateFileResponse . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AnnotateFileResponse . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public AnnotateFileResponse . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
