Class AnnotateFileRequest (3.12.0)
Version 3.12.0keyboard_arrow_down
public final class AnnotateFileRequest extends GeneratedMessageV3 implements AnnotateFileRequestOrBuilder
A request to annotate one single file, e.g. a PDF, TIFF or GIF file.
Protobuf type google.cloud.vision.v1p4beta1.AnnotateFileRequest
Static Fields
FEATURES_FIELD_NUMBER
public static final int FEATURES_FIELD_NUMBER
Field Value
Type Description
int
IMAGE_CONTEXT_FIELD_NUMBER
public static final int IMAGE_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int
public static final int INPUT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int
PAGES_FIELD_NUMBER
public static final int PAGES_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static AnnotateFileRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static AnnotateFileRequest . Builder newBuilder ()
newBuilder(AnnotateFileRequest prototype)
public static AnnotateFileRequest . Builder newBuilder ( AnnotateFileRequest prototype )
public static AnnotateFileRequest parseDelimitedFrom ( InputStream input )
public static AnnotateFileRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static AnnotateFileRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AnnotateFileRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static AnnotateFileRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AnnotateFileRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static AnnotateFileRequest parseFrom ( CodedInputStream input )
public static AnnotateFileRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static AnnotateFileRequest parseFrom ( InputStream input )
public static AnnotateFileRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static AnnotateFileRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AnnotateFileRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<AnnotateFileRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public AnnotateFileRequest getDefaultInstanceForType ()
getFeatures(int index)
public Feature getFeatures ( int index )
Required. Requested features.
repeated .google.cloud.vision.v1p4beta1.Feature features = 2;
Parameter
Name Description
indexint
getFeaturesCount()
public int getFeaturesCount ()
Required. Requested features.
repeated .google.cloud.vision.v1p4beta1.Feature features = 2;
Returns
Type Description
int
getFeaturesList()
public List<Feature> getFeaturesList ()
Required. Requested features.
repeated .google.cloud.vision.v1p4beta1.Feature features = 2;
getFeaturesOrBuilder(int index)
public FeatureOrBuilder getFeaturesOrBuilder ( int index )
Required. Requested features.
repeated .google.cloud.vision.v1p4beta1.Feature features = 2;
Parameter
Name Description
indexint
getFeaturesOrBuilderList()
public List <? extends FeatureOrBuilder > getFeaturesOrBuilderList ()
Required. Requested features.
repeated .google.cloud.vision.v1p4beta1.Feature features = 2;
Returns
Type Description
List <? extends com.google.cloud.vision.v1p4beta1.FeatureOrBuilder >
getImageContext()
public ImageContext getImageContext ()
Additional context that may accompany the image(s) in the file.
.google.cloud.vision.v1p4beta1.ImageContext image_context = 3;
getImageContextOrBuilder()
public ImageContextOrBuilder getImageContextOrBuilder ()
Additional context that may accompany the image(s) in the file.
.google.cloud.vision.v1p4beta1.ImageContext image_context = 3;
public InputConfig getInputConfig ()
Required. Information about the input file.
.google.cloud.vision.v1p4beta1.InputConfig input_config = 1;
public InputConfigOrBuilder getInputConfigOrBuilder ()
Required. Information about the input file.
.google.cloud.vision.v1p4beta1.InputConfig input_config = 1;
getPages(int index)
public int getPages ( int index )
Pages of the file to perform image annotation.
Pages starts from 1, we assume the first page of the file is page 1.
At most 5 pages are supported per request. Pages can be negative.
Page 1 means the first page.
Page 2 means the second page.
Page -1 means the last page.
Page -2 means the second to the last page.
If the file is GIF instead of PDF or TIFF, page refers to GIF frames.
If this field is empty, by default the service performs image annotation
for the first 5 pages of the file.
repeated int32 pages = 4;
Parameter
Name Description
indexint The index of the element to return.
Returns
Type Description
int The pages at the given index.
getPagesCount()
public int getPagesCount ()
Pages of the file to perform image annotation.
Pages starts from 1, we assume the first page of the file is page 1.
At most 5 pages are supported per request. Pages can be negative.
Page 1 means the first page.
Page 2 means the second page.
Page -1 means the last page.
Page -2 means the second to the last page.
If the file is GIF instead of PDF or TIFF, page refers to GIF frames.
If this field is empty, by default the service performs image annotation
for the first 5 pages of the file.
repeated int32 pages = 4;
Returns
Type Description
int The count of pages.
getPagesList()
public List<Integer> getPagesList ()
Pages of the file to perform image annotation.
Pages starts from 1, we assume the first page of the file is page 1.
At most 5 pages are supported per request. Pages can be negative.
Page 1 means the first page.
Page 2 means the second page.
Page -1 means the last page.
Page -2 means the second to the last page.
If the file is GIF instead of PDF or TIFF, page refers to GIF frames.
If this field is empty, by default the service performs image annotation
for the first 5 pages of the file.
repeated int32 pages = 4;
Returns
Type Description
List <Integer >A list containing the pages.
getParserForType()
public Parser<AnnotateFileRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
hasImageContext()
public boolean hasImageContext ()
Additional context that may accompany the image(s) in the file.
.google.cloud.vision.v1p4beta1.ImageContext image_context = 3;
Returns
Type Description
boolean Whether the imageContext field is set.
public boolean hasInputConfig ()
Required. Information about the input file.
.google.cloud.vision.v1p4beta1.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 AnnotateFileRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AnnotateFileRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public AnnotateFileRequest . 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-29 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-29 UTC."],[],[]]
