com.google.cloud.vision.v1

Interface AnnotateFileRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

AnnotateFileRequest, AnnotateFileRequest.Builder

public interface AnnotateFileRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Feature	getFeatures(int index) Required.
int	getFeaturesCount() Required.
List<Feature>	getFeaturesList() Required.
FeatureOrBuilder	getFeaturesOrBuilder(int index) Required.
List<? extends FeatureOrBuilder>	getFeaturesOrBuilderList() Required.
ImageContext	getImageContext() Additional context that may accompany the image(s) in the file.
ImageContextOrBuilder	getImageContextOrBuilder() Additional context that may accompany the image(s) in the file.
InputConfig	getInputConfig() Required.
InputConfigOrBuilder	getInputConfigOrBuilder() Required.
int	getPages(int index) Pages of the file to perform image annotation.
int	getPagesCount() Pages of the file to perform image annotation.
List<Integer>	getPagesList() Pages of the file to perform image annotation.
boolean	hasImageContext() Additional context that may accompany the image(s) in the file.
boolean	hasInputConfig() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasInputConfig

boolean hasInputConfig()

 Required. Information about the input file.
 

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

Returns:

Whether the inputConfig field is set.

getInputConfig

InputConfig getInputConfig()

 Required. Information about the input file.
 

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

Returns:

The inputConfig.

getInputConfigOrBuilder

InputConfigOrBuilder getInputConfigOrBuilder()

 Required. Information about the input file.
 

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

getFeaturesList

List<Feature> getFeaturesList()

 Required. Requested features.
 

repeated .google.cloud.vision.v1.Feature features = 2;

getFeatures

Feature getFeatures(int index)

 Required. Requested features.
 

repeated .google.cloud.vision.v1.Feature features = 2;

getFeaturesCount

int getFeaturesCount()

 Required. Requested features.
 

repeated .google.cloud.vision.v1.Feature features = 2;

getFeaturesOrBuilderList

List<? extends FeatureOrBuilder> getFeaturesOrBuilderList()

 Required. Requested features.
 

repeated .google.cloud.vision.v1.Feature features = 2;

getFeaturesOrBuilder

FeatureOrBuilder getFeaturesOrBuilder(int index)

 Required. Requested features.
 

repeated .google.cloud.vision.v1.Feature features = 2;

hasImageContext

boolean hasImageContext()

 Additional context that may accompany the image(s) in the file.
 

.google.cloud.vision.v1.ImageContext image_context = 3;

Returns:

Whether the imageContext field is set.

getImageContext

ImageContext getImageContext()

 Additional context that may accompany the image(s) in the file.
 

.google.cloud.vision.v1.ImageContext image_context = 3;

Returns:

The imageContext.

getImageContextOrBuilder

ImageContextOrBuilder getImageContextOrBuilder()

 Additional context that may accompany the image(s) in the file.
 

.google.cloud.vision.v1.ImageContext image_context = 3;

getPagesList

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:

A list containing the pages.

getPagesCount

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:

The count of pages.

getPages

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;

Parameters:

index - The index of the element to return.

Returns:

The pages at the given index.