Class AsyncBatchAnnotateFilesRequest.Builder (3.45.0)

public static final class AsyncBatchAnnotateFilesRequest.Builder extends GeneratedMessageV3.Builder<AsyncBatchAnnotateFilesRequest.Builder> implements AsyncBatchAnnotateFilesRequestOrBuilder

Multiple async file annotation requests are batched into a single service call.

Protobuf type google.cloud.vision.v1.AsyncBatchAnnotateFilesRequest

Static Methods

getDescriptor()

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

Methods

addAllRequests(Iterable<? extends AsyncAnnotateFileRequest> values)

public AsyncBatchAnnotateFilesRequest.Builder addAllRequests(Iterable<? extends AsyncAnnotateFileRequest> values)

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.cloud.vision.v1.AsyncAnnotateFileRequest>
Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addRequests(AsyncAnnotateFileRequest value)

public AsyncBatchAnnotateFilesRequest.Builder addRequests(AsyncAnnotateFileRequest value)

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value AsyncAnnotateFileRequest
Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

addRequests(AsyncAnnotateFileRequest.Builder builderForValue)

public AsyncBatchAnnotateFilesRequest.Builder addRequests(AsyncAnnotateFileRequest.Builder builderForValue)

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue AsyncAnnotateFileRequest.Builder
Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

addRequests(int index, AsyncAnnotateFileRequest value)

public AsyncBatchAnnotateFilesRequest.Builder addRequests(int index, AsyncAnnotateFileRequest value)

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value AsyncAnnotateFileRequest
Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

addRequests(int index, AsyncAnnotateFileRequest.Builder builderForValue)

public AsyncBatchAnnotateFilesRequest.Builder addRequests(int index, AsyncAnnotateFileRequest.Builder builderForValue)

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue AsyncAnnotateFileRequest.Builder
Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

addRequestsBuilder()

public AsyncAnnotateFileRequest.Builder addRequestsBuilder()

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AsyncAnnotateFileRequest.Builder

addRequestsBuilder(int index)

public AsyncAnnotateFileRequest.Builder addRequestsBuilder(int index)

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AsyncAnnotateFileRequest.Builder

build()

public AsyncBatchAnnotateFilesRequest build()
Returns
Type Description
AsyncBatchAnnotateFilesRequest

buildPartial()

public AsyncBatchAnnotateFilesRequest buildPartial()
Returns
Type Description
AsyncBatchAnnotateFilesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearLabels()

public AsyncBatchAnnotateFilesRequest.Builder clearLabels()
Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public AsyncBatchAnnotateFilesRequest.Builder clearParent()

Optional. Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no parent is specified, a region will be chosen automatically.

Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

Example: projects/project-A/locations/eu.

string parent = 4;

Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

This builder for chaining.

clearRequests()

public AsyncBatchAnnotateFilesRequest.Builder clearRequests()

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

clone()

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

containsLabels(String key)

public boolean containsLabels(String key)

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public AsyncBatchAnnotateFilesRequest getDefaultInstanceForType()
Returns
Type Description
AsyncBatchAnnotateFilesRequest

getDescriptorForType()

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

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getParent()

public String getParent()

Optional. Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no parent is specified, a region will be chosen automatically.

Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

Example: projects/project-A/locations/eu.

string parent = 4;

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Optional. Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no parent is specified, a region will be chosen automatically.

Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

Example: projects/project-A/locations/eu.

string parent = 4;

Returns
Type Description
ByteString

The bytes for parent.

getRequests(int index)

public AsyncAnnotateFileRequest getRequests(int index)

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AsyncAnnotateFileRequest

getRequestsBuilder(int index)

public AsyncAnnotateFileRequest.Builder getRequestsBuilder(int index)

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AsyncAnnotateFileRequest.Builder

getRequestsBuilderList()

public List<AsyncAnnotateFileRequest.Builder> getRequestsBuilderList()

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getRequestsCount()

public int getRequestsCount()

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getRequestsList()

public List<AsyncAnnotateFileRequest> getRequestsList()

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<AsyncAnnotateFileRequest>

getRequestsOrBuilder(int index)

public AsyncAnnotateFileRequestOrBuilder getRequestsOrBuilder(int index)

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AsyncAnnotateFileRequestOrBuilder

getRequestsOrBuilderList()

public List<? extends AsyncAnnotateFileRequestOrBuilder> getRequestsOrBuilderList()

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

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

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AsyncBatchAnnotateFilesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllLabels(Map<String,String> values)

public AsyncBatchAnnotateFilesRequest.Builder putAllLabels(Map<String,String> values)

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

putLabels(String key, String value)

public AsyncBatchAnnotateFilesRequest.Builder putLabels(String key, String value)

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

removeLabels(String key)

public AsyncBatchAnnotateFilesRequest.Builder removeLabels(String key)

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

removeRequests(int index)

public AsyncBatchAnnotateFilesRequest.Builder removeRequests(int index)

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setParent(String value)

public AsyncBatchAnnotateFilesRequest.Builder setParent(String value)

Optional. Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no parent is specified, a region will be chosen automatically.

Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

Example: projects/project-A/locations/eu.

string parent = 4;

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public AsyncBatchAnnotateFilesRequest.Builder setParentBytes(ByteString value)

Optional. Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no parent is specified, a region will be chosen automatically.

Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

Example: projects/project-A/locations/eu.

string parent = 4;

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

This builder for chaining.

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

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

setRequests(int index, AsyncAnnotateFileRequest value)

public AsyncBatchAnnotateFilesRequest.Builder setRequests(int index, AsyncAnnotateFileRequest value)

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value AsyncAnnotateFileRequest
Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

setRequests(int index, AsyncAnnotateFileRequest.Builder builderForValue)

public AsyncBatchAnnotateFilesRequest.Builder setRequests(int index, AsyncAnnotateFileRequest.Builder builderForValue)

Required. Individual async file annotation requests for this batch.

repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue AsyncAnnotateFileRequest.Builder
Returns
Type Description
AsyncBatchAnnotateFilesRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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