Package com.google.cloud.vision.v1

Class AnnotateFileRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.vision.v1.AnnotateFileRequest

All Implemented Interfaces:

AnnotateFileRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class AnnotateFileRequest
extends com.google.protobuf.GeneratedMessageV3
implements AnnotateFileRequestOrBuilder

 A request to annotate one single file, e.g. a PDF, TIFF or GIF file.
 

Protobuf type google.cloud.vision.v1.AnnotateFileRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnnotateFileRequest.Builder	A request to annotate one single file, e.g.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	FEATURES_FIELD_NUMBER
static int	IMAGE_CONTEXT_FIELD_NUMBER
static int	INPUT_CONFIG_FIELD_NUMBER
static int	PAGES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static AnnotateFileRequest	getDefaultInstance()
AnnotateFileRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<AnnotateFileRequest>	getParserForType()
int	getSerializedSize()
int	hashCode()
boolean	hasImageContext()	Additional context that may accompany the image(s) in the file.
boolean	hasInputConfig()	Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AnnotateFileRequest.Builder	newBuilder()
static AnnotateFileRequest.Builder	newBuilder(AnnotateFileRequest prototype)
AnnotateFileRequest.Builder	newBuilderForType()
protected AnnotateFileRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AnnotateFileRequest	parseDelimitedFrom(InputStream input)
static AnnotateFileRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateFileRequest	parseFrom(byte[] data)
static AnnotateFileRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateFileRequest	parseFrom(com.google.protobuf.ByteString data)
static AnnotateFileRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateFileRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static AnnotateFileRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateFileRequest	parseFrom(InputStream input)
static AnnotateFileRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateFileRequest	parseFrom(ByteBuffer data)
static AnnotateFileRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AnnotateFileRequest>	parser()
AnnotateFileRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

INPUT_CONFIG_FIELD_NUMBER

public static final int INPUT_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

FEATURES_FIELD_NUMBER

public static final int FEATURES_FIELD_NUMBER

See Also:

Constant Field Values

IMAGE_CONTEXT_FIELD_NUMBER

public static final int IMAGE_CONTEXT_FIELD_NUMBER

See Also:

Constant Field Values

PAGES_FIELD_NUMBER

public static final int PAGES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasInputConfig

public boolean hasInputConfig()

 Required. Information about the input file.
 

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

Specified by:

hasInputConfig in interface AnnotateFileRequestOrBuilder

Returns:

Whether the inputConfig field is set.

getInputConfig

public InputConfig getInputConfig()

 Required. Information about the input file.
 

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

Specified by:

getInputConfig in interface AnnotateFileRequestOrBuilder

Returns:

The inputConfig.

getInputConfigOrBuilder

public InputConfigOrBuilder getInputConfigOrBuilder()

 Required. Information about the input file.
 

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

Specified by:

getInputConfigOrBuilder in interface AnnotateFileRequestOrBuilder

getFeaturesList

public List<Feature> getFeaturesList()

 Required. Requested features.
 

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

Specified by:

getFeaturesList in interface AnnotateFileRequestOrBuilder

getFeaturesOrBuilderList

public List<? extends FeatureOrBuilder> getFeaturesOrBuilderList()

 Required. Requested features.
 

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

Specified by:

getFeaturesOrBuilderList in interface AnnotateFileRequestOrBuilder

getFeaturesCount

public int getFeaturesCount()

 Required. Requested features.
 

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

Specified by:

getFeaturesCount in interface AnnotateFileRequestOrBuilder

getFeatures

public Feature getFeatures(int index)

 Required. Requested features.
 

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

Specified by:

getFeatures in interface AnnotateFileRequestOrBuilder

getFeaturesOrBuilder

public FeatureOrBuilder getFeaturesOrBuilder(int index)

 Required. Requested features.
 

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

Specified by:

getFeaturesOrBuilder in interface AnnotateFileRequestOrBuilder

hasImageContext

public boolean hasImageContext()

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

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

Specified by:

hasImageContext in interface AnnotateFileRequestOrBuilder

Returns:

Whether the imageContext field is set.

getImageContext

public ImageContext getImageContext()

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

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

Specified by:

getImageContext in interface AnnotateFileRequestOrBuilder

Returns:

The imageContext.

getImageContextOrBuilder

public ImageContextOrBuilder getImageContextOrBuilder()

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

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

Specified by:

getImageContextOrBuilder in interface AnnotateFileRequestOrBuilder

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;

Specified by:

getPagesList in interface AnnotateFileRequestOrBuilder

Returns:

A list containing the pages.

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;

Specified by:

getPagesCount in interface AnnotateFileRequestOrBuilder

Returns:

The count of pages.

getPages

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;

Specified by:

getPages in interface AnnotateFileRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The pages at the given index.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AnnotateFileRequest parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateFileRequest parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateFileRequest parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateFileRequest parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateFileRequest parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateFileRequest parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateFileRequest parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static AnnotateFileRequest parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnnotateFileRequest parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnnotateFileRequest parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static AnnotateFileRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static AnnotateFileRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public AnnotateFileRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AnnotateFileRequest.Builder newBuilder()

newBuilder

public static AnnotateFileRequest.Builder newBuilder(AnnotateFileRequest prototype)

toBuilder

public AnnotateFileRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AnnotateFileRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AnnotateFileRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<AnnotateFileRequest> parser()

getParserForType

public com.google.protobuf.Parser<AnnotateFileRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AnnotateFileRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder