- 3.53.0 (latest)
- 3.52.0
- 3.51.0
- 3.50.0
- 3.49.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.39.0
- 3.38.0
- 3.37.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.27.0
- 3.26.0
- 3.25.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.3
- 2.1.4
- 2.0.29
public static final class AnnotateFileRequest.Builder extends GeneratedMessageV3.Builder<AnnotateFileRequest.Builder> implements AnnotateFileRequestOrBuilderA request to annotate one single file, e.g. a PDF, TIFF or GIF file.
Protobuf type google.cloud.vision.v1.AnnotateFileRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AnnotateFileRequest.BuilderImplements
AnnotateFileRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllFeatures(Iterable<? extends Feature> values)
public AnnotateFileRequest.Builder addAllFeatures(Iterable<? extends Feature> values)Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.vision.v1.Feature> |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
addAllPages(Iterable<? extends Integer> values)
public AnnotateFileRequest.Builder addAllPages(Iterable<? extends Integer> values)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;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends java.lang.Integer>The pages to add. |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
This builder for chaining. |
addFeatures(Feature value)
public AnnotateFileRequest.Builder addFeatures(Feature value)Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Feature |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
addFeatures(Feature.Builder builderForValue)
public AnnotateFileRequest.Builder addFeatures(Feature.Builder builderForValue)Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Feature.Builder |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
addFeatures(int index, Feature value)
public AnnotateFileRequest.Builder addFeatures(int index, Feature value)Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Feature |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
addFeatures(int index, Feature.Builder builderForValue)
public AnnotateFileRequest.Builder addFeatures(int index, Feature.Builder builderForValue)Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Feature.Builder |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
addFeaturesBuilder()
public Feature.Builder addFeaturesBuilder()Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Returns | |
|---|---|
| Type | Description |
Feature.Builder |
|
addFeaturesBuilder(int index)
public Feature.Builder addFeaturesBuilder(int index)Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Feature.Builder |
|
addPages(int value)
public AnnotateFileRequest.Builder addPages(int value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pages to add. |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AnnotateFileRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
build()
public AnnotateFileRequest build()| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest |
|
buildPartial()
public AnnotateFileRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest |
|
clear()
public AnnotateFileRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
clearFeatures()
public AnnotateFileRequest.Builder clearFeatures()Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public AnnotateFileRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
clearImageContext()
public AnnotateFileRequest.Builder clearImageContext()Additional context that may accompany the image(s) in the file.
.google.cloud.vision.v1.ImageContext image_context = 3;
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
clearInputConfig()
public AnnotateFileRequest.Builder clearInputConfig()Required. Information about the input file.
.google.cloud.vision.v1.InputConfig input_config = 1;
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public AnnotateFileRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
clearPages()
public AnnotateFileRequest.Builder clearPages()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 | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
This builder for chaining. |
clone()
public AnnotateFileRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
getDefaultInstanceForType()
public AnnotateFileRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFeatures(int index)
public Feature getFeatures(int index)Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Feature |
|
getFeaturesBuilder(int index)
public Feature.Builder getFeaturesBuilder(int index)Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Feature.Builder |
|
getFeaturesBuilderList()
public List<Feature.Builder> getFeaturesBuilderList()Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getFeaturesCount()
public int getFeaturesCount()Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Returns | |
|---|---|
| Type | Description |
int |
|
getFeaturesList()
public List<Feature> getFeaturesList()Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Returns | |
|---|---|
| Type | Description |
List<Feature> |
|
getFeaturesOrBuilder(int index)
public FeatureOrBuilder getFeaturesOrBuilder(int index)Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FeatureOrBuilder |
|
getFeaturesOrBuilderList()
public List<? extends FeatureOrBuilder> getFeaturesOrBuilderList()Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.vision.v1.FeatureOrBuilder> |
|
getImageContext()
public ImageContext getImageContext()Additional context that may accompany the image(s) in the file.
.google.cloud.vision.v1.ImageContext image_context = 3;
| Returns | |
|---|---|
| Type | Description |
ImageContext |
The imageContext. |
getImageContextBuilder()
public ImageContext.Builder getImageContextBuilder()Additional context that may accompany the image(s) in the file.
.google.cloud.vision.v1.ImageContext image_context = 3;
| Returns | |
|---|---|
| Type | Description |
ImageContext.Builder |
|
getImageContextOrBuilder()
public ImageContextOrBuilder getImageContextOrBuilder()Additional context that may accompany the image(s) in the file.
.google.cloud.vision.v1.ImageContext image_context = 3;
| Returns | |
|---|---|
| Type | Description |
ImageContextOrBuilder |
|
getInputConfig()
public InputConfig getInputConfig()Required. Information about the input file.
.google.cloud.vision.v1.InputConfig input_config = 1;
| Returns | |
|---|---|
| Type | Description |
InputConfig |
The inputConfig. |
getInputConfigBuilder()
public InputConfig.Builder getInputConfigBuilder()Required. Information about the input file.
.google.cloud.vision.v1.InputConfig input_config = 1;
| Returns | |
|---|---|
| Type | Description |
InputConfig.Builder |
|
getInputConfigOrBuilder()
public InputConfigOrBuilder getInputConfigOrBuilder()Required. Information about the input file.
.google.cloud.vision.v1.InputConfig input_config = 1;
| Returns | |
|---|---|
| Type | Description |
InputConfigOrBuilder |
|
getPages(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The pages at the given index. |
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;
| Returns | |
|---|---|
| Type | Description |
int |
The count of pages. |
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;
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the pages. |
hasImageContext()
public boolean hasImageContext()Additional context that may accompany the image(s) in the file.
.google.cloud.vision.v1.ImageContext image_context = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the imageContext field is set. |
hasInputConfig()
public boolean hasInputConfig()Required. Information about the input file.
.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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(AnnotateFileRequest other)
public AnnotateFileRequest.Builder mergeFrom(AnnotateFileRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
AnnotateFileRequest |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AnnotateFileRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public AnnotateFileRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
mergeImageContext(ImageContext value)
public AnnotateFileRequest.Builder mergeImageContext(ImageContext value)Additional context that may accompany the image(s) in the file.
.google.cloud.vision.v1.ImageContext image_context = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ImageContext |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
mergeInputConfig(InputConfig value)
public AnnotateFileRequest.Builder mergeInputConfig(InputConfig value)Required. Information about the input file.
.google.cloud.vision.v1.InputConfig input_config = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
InputConfig |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AnnotateFileRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
removeFeatures(int index)
public AnnotateFileRequest.Builder removeFeatures(int index)Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
setFeatures(int index, Feature value)
public AnnotateFileRequest.Builder setFeatures(int index, Feature value)Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Feature |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
setFeatures(int index, Feature.Builder builderForValue)
public AnnotateFileRequest.Builder setFeatures(int index, Feature.Builder builderForValue)Required. Requested features.
repeated .google.cloud.vision.v1.Feature features = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Feature.Builder |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public AnnotateFileRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
setImageContext(ImageContext value)
public AnnotateFileRequest.Builder setImageContext(ImageContext value)Additional context that may accompany the image(s) in the file.
.google.cloud.vision.v1.ImageContext image_context = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ImageContext |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
setImageContext(ImageContext.Builder builderForValue)
public AnnotateFileRequest.Builder setImageContext(ImageContext.Builder builderForValue)Additional context that may accompany the image(s) in the file.
.google.cloud.vision.v1.ImageContext image_context = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ImageContext.Builder |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
setInputConfig(InputConfig value)
public AnnotateFileRequest.Builder setInputConfig(InputConfig value)Required. Information about the input file.
.google.cloud.vision.v1.InputConfig input_config = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
InputConfig |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
setInputConfig(InputConfig.Builder builderForValue)
public AnnotateFileRequest.Builder setInputConfig(InputConfig.Builder builderForValue)Required. Information about the input file.
.google.cloud.vision.v1.InputConfig input_config = 1;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
InputConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
setPages(int index, int value)
public AnnotateFileRequest.Builder setPages(int index, int value)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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe pages to set. |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AnnotateFileRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final AnnotateFileRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AnnotateFileRequest.Builder |
|