Class AnnotateFileResponse.Builder (3.42.0)

public static final class AnnotateFileResponse.Builder extends GeneratedMessageV3.Builder<AnnotateFileResponse.Builder> 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 Methods

getDescriptor()

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

Methods

addAllResponses(Iterable<? extends AnnotateImageResponse> values)

public AnnotateFileResponse.Builder addAllResponses(Iterable<? extends AnnotateImageResponse> values)

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
Name Description
values Iterable<? extends com.google.cloud.vision.v1.AnnotateImageResponse>
Returns
Type Description
AnnotateFileResponse.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AnnotateFileResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnnotateFileResponse.Builder
Overrides

addResponses(AnnotateImageResponse value)

public AnnotateFileResponse.Builder addResponses(AnnotateImageResponse value)

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
Name Description
value AnnotateImageResponse
Returns
Type Description
AnnotateFileResponse.Builder

addResponses(AnnotateImageResponse.Builder builderForValue)

public AnnotateFileResponse.Builder addResponses(AnnotateImageResponse.Builder builderForValue)

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
Name Description
builderForValue AnnotateImageResponse.Builder
Returns
Type Description
AnnotateFileResponse.Builder

addResponses(int index, AnnotateImageResponse value)

public AnnotateFileResponse.Builder addResponses(int index, AnnotateImageResponse value)

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;

Parameters
Name Description
index int
value AnnotateImageResponse
Returns
Type Description
AnnotateFileResponse.Builder

addResponses(int index, AnnotateImageResponse.Builder builderForValue)

public AnnotateFileResponse.Builder addResponses(int index, AnnotateImageResponse.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue AnnotateImageResponse.Builder
Returns
Type Description
AnnotateFileResponse.Builder

addResponsesBuilder()

public AnnotateImageResponse.Builder addResponsesBuilder()

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
Type Description
AnnotateImageResponse.Builder

addResponsesBuilder(int index)

public AnnotateImageResponse.Builder addResponsesBuilder(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
Name Description
index int
Returns
Type Description
AnnotateImageResponse.Builder

build()

public AnnotateFileResponse build()
Returns
Type Description
AnnotateFileResponse

buildPartial()

public AnnotateFileResponse buildPartial()
Returns
Type Description
AnnotateFileResponse

clear()

public AnnotateFileResponse.Builder clear()
Returns
Type Description
AnnotateFileResponse.Builder
Overrides

clearError()

public AnnotateFileResponse.Builder clearError()

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
AnnotateFileResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public AnnotateFileResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AnnotateFileResponse.Builder
Overrides

clearInputConfig()

public AnnotateFileResponse.Builder clearInputConfig()

Information about the file for which this response is generated.

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

Returns
Type Description
AnnotateFileResponse.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public AnnotateFileResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AnnotateFileResponse.Builder
Overrides

clearResponses()

public AnnotateFileResponse.Builder clearResponses()

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
Type Description
AnnotateFileResponse.Builder

clearTotalPages()

public AnnotateFileResponse.Builder clearTotalPages()

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

int32 total_pages = 3;

Returns
Type Description
AnnotateFileResponse.Builder

This builder for chaining.

clone()

public AnnotateFileResponse.Builder clone()
Returns
Type Description
AnnotateFileResponse.Builder
Overrides

getDefaultInstanceForType()

public AnnotateFileResponse getDefaultInstanceForType()
Returns
Type Description
AnnotateFileResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getErrorBuilder()

public Status.Builder getErrorBuilder()

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.Builder

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.v1.InputConfig input_config = 1;

Returns
Type Description
InputConfig

The inputConfig.

getInputConfigBuilder()

public InputConfig.Builder getInputConfigBuilder()

Information about the file for which this response is generated.

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

Returns
Type Description
InputConfig.Builder

getInputConfigOrBuilder()

public InputConfigOrBuilder getInputConfigOrBuilder()

Information about the file for which this response is generated.

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

Returns
Type Description
InputConfigOrBuilder

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
Name Description
index int
Returns
Type Description
AnnotateImageResponse

getResponsesBuilder(int index)

public AnnotateImageResponse.Builder getResponsesBuilder(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
Name Description
index int
Returns
Type Description
AnnotateImageResponse.Builder

getResponsesBuilderList()

public List<AnnotateImageResponse.Builder> getResponsesBuilderList()

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
Type Description
List<Builder>

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
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.v1.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.v1.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.v1.AnnotateImageResponse responses = 2;

Returns
Type Description
List<? extends com.google.cloud.vision.v1.AnnotateImageResponseOrBuilder>

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.v1.InputConfig input_config = 1;

Returns
Type Description
boolean

Whether the inputConfig field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeError(Status value)

public AnnotateFileResponse.Builder mergeError(Status value)

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;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
AnnotateFileResponse.Builder

mergeFrom(AnnotateFileResponse other)

public AnnotateFileResponse.Builder mergeFrom(AnnotateFileResponse other)
Parameter
Name Description
other AnnotateFileResponse
Returns
Type Description
AnnotateFileResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AnnotateFileResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateFileResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AnnotateFileResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AnnotateFileResponse.Builder
Overrides

mergeInputConfig(InputConfig value)

public AnnotateFileResponse.Builder mergeInputConfig(InputConfig value)

Information about the file for which this response is generated.

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

Parameter
Name Description
value InputConfig
Returns
Type Description
AnnotateFileResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AnnotateFileResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnnotateFileResponse.Builder
Overrides

removeResponses(int index)

public AnnotateFileResponse.Builder removeResponses(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
Name Description
index int
Returns
Type Description
AnnotateFileResponse.Builder

setError(Status value)

public AnnotateFileResponse.Builder setError(Status value)

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;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
AnnotateFileResponse.Builder

setError(Status.Builder builderForValue)

public AnnotateFileResponse.Builder setError(Status.Builder builderForValue)

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;

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
AnnotateFileResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AnnotateFileResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnnotateFileResponse.Builder
Overrides

setInputConfig(InputConfig value)

public AnnotateFileResponse.Builder setInputConfig(InputConfig value)

Information about the file for which this response is generated.

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

Parameter
Name Description
value InputConfig
Returns
Type Description
AnnotateFileResponse.Builder

setInputConfig(InputConfig.Builder builderForValue)

public AnnotateFileResponse.Builder setInputConfig(InputConfig.Builder builderForValue)

Information about the file for which this response is generated.

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

Parameter
Name Description
builderForValue InputConfig.Builder
Returns
Type Description
AnnotateFileResponse.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AnnotateFileResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AnnotateFileResponse.Builder
Overrides

setResponses(int index, AnnotateImageResponse value)

public AnnotateFileResponse.Builder setResponses(int index, AnnotateImageResponse value)

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;

Parameters
Name Description
index int
value AnnotateImageResponse
Returns
Type Description
AnnotateFileResponse.Builder

setResponses(int index, AnnotateImageResponse.Builder builderForValue)

public AnnotateFileResponse.Builder setResponses(int index, AnnotateImageResponse.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue AnnotateImageResponse.Builder
Returns
Type Description
AnnotateFileResponse.Builder

setTotalPages(int value)

public AnnotateFileResponse.Builder setTotalPages(int value)

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

int32 total_pages = 3;

Parameter
Name Description
value int

The totalPages to set.

Returns
Type Description
AnnotateFileResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AnnotateFileResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnnotateFileResponse.Builder
Overrides