Class AnnotateFileResponse (3.6.0)

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

Static Fields

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_CONFIG_FIELD_NUMBER

public static final int INPUT_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

RESPONSES_FIELD_NUMBER

public static final int RESPONSES_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_PAGES_FIELD_NUMBER

public static final int TOTAL_PAGES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AnnotateFileResponse getDefaultInstance()
Returns
TypeDescription
AnnotateFileResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AnnotateFileResponse.Builder newBuilder()
Returns
TypeDescription
AnnotateFileResponse.Builder

newBuilder(AnnotateFileResponse prototype)

public static AnnotateFileResponse.Builder newBuilder(AnnotateFileResponse prototype)
Parameter
NameDescription
prototypeAnnotateFileResponse
Returns
TypeDescription
AnnotateFileResponse.Builder

parseDelimitedFrom(InputStream input)

public static AnnotateFileResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnnotateFileResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateFileResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AnnotateFileResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AnnotateFileResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateFileResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotateFileResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AnnotateFileResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateFileResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotateFileResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AnnotateFileResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateFileResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AnnotateFileResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnnotateFileResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateFileResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AnnotateFileResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AnnotateFileResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateFileResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AnnotateFileResponse> parser()
Returns
TypeDescription
Parser<AnnotateFileResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public AnnotateFileResponse getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
InputConfigOrBuilder

getParserForType()

public Parser<AnnotateFileResponse> getParserForType()
Returns
TypeDescription
Parser<AnnotateFileResponse>
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.vision.v1.AnnotateImageResponseOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTotalPages()

public int getTotalPages()

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

int32 total_pages = 3;

Returns
TypeDescription
int

The totalPages.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
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
TypeDescription
boolean

Whether the inputConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AnnotateFileResponse.Builder newBuilderForType()
Returns
TypeDescription
AnnotateFileResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotateFileResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AnnotateFileResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AnnotateFileResponse.Builder toBuilder()
Returns
TypeDescription
AnnotateFileResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException