Class AnnotateFileResponse (3.45.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.v1p4beta1.AnnotateFileResponse

Static Fields

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

INPUT_CONFIG_FIELD_NUMBER

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()
Returns
Type Description
AnnotateFileResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AnnotateFileResponse.Builder newBuilder()
Returns
Type Description
AnnotateFileResponse.Builder

newBuilder(AnnotateFileResponse prototype)

public static AnnotateFileResponse.Builder newBuilder(AnnotateFileResponse prototype)
Parameter
Name Description
prototype AnnotateFileResponse
Returns
Type Description
AnnotateFileResponse.Builder

parseDelimitedFrom(InputStream input)

public static AnnotateFileResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotateFileResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateFileResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AnnotateFileResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AnnotateFileResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateFileResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotateFileResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnnotateFileResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateFileResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotateFileResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnnotateFileResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateFileResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AnnotateFileResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotateFileResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateFileResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AnnotateFileResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnnotateFileResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotateFileResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateFileResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AnnotateFileResponse> parser()
Returns
Type Description
Parser<AnnotateFileResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public AnnotateFileResponse getDefaultInstanceForType()
Returns
Type Description
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
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

getInputConfig()

public InputConfig getInputConfig()

Information about the file for which this response is generated.

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

Returns
Type Description
InputConfig

The inputConfig.

getInputConfigOrBuilder()

public InputConfigOrBuilder getInputConfigOrBuilder()

Information about the file for which this response is generated.

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

Returns
Type Description
InputConfigOrBuilder

getParserForType()

public Parser<AnnotateFileResponse> getParserForType()
Returns
Type Description
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.v1p4beta1.AnnotateImageResponse responses = 2;

Parameter
Name Description
index int
Returns
Type Description
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.v1p4beta1.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.v1p4beta1.AnnotateImageResponse responses = 2;

Returns
Type Description
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.v1p4beta1.AnnotateImageResponse responses = 2;

Parameter
Name Description
index int
Returns
Type Description
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.v1p4beta1.AnnotateImageResponse responses = 2;

Returns
Type Description
List<? extends com.google.cloud.vision.v1p4beta1.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.

hasInputConfig()

public boolean hasInputConfig()

Information about the file for which this response is generated.

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

Returns
Type Description
boolean

Whether the inputConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AnnotateFileResponse.Builder newBuilderForType()
Returns
Type Description
AnnotateFileResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotateFileResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AnnotateFileResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AnnotateFileResponse.Builder toBuilder()
Returns
Type Description
AnnotateFileResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException