Class BatchAnnotateFilesRequest.Builder (3.40.0)

public static final class BatchAnnotateFilesRequest.Builder extends GeneratedMessageV3.Builder<BatchAnnotateFilesRequest.Builder> implements BatchAnnotateFilesRequestOrBuilder

A list of requests to annotate files using the BatchAnnotateFiles API.

Protobuf type google.cloud.vision.v1.BatchAnnotateFilesRequest

Static Methods

getDescriptor()

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

Methods

addAllRequests(Iterable<? extends AnnotateFileRequest> values)

public BatchAnnotateFilesRequest.Builder addAllRequests(Iterable<? extends AnnotateFileRequest> values)

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addRequests(AnnotateFileRequest value)

public BatchAnnotateFilesRequest.Builder addRequests(AnnotateFileRequest value)

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Parameter
Name Description
value AnnotateFileRequest
Returns
Type Description
BatchAnnotateFilesRequest.Builder

addRequests(AnnotateFileRequest.Builder builderForValue)

public BatchAnnotateFilesRequest.Builder addRequests(AnnotateFileRequest.Builder builderForValue)

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Parameter
Name Description
builderForValue AnnotateFileRequest.Builder
Returns
Type Description
BatchAnnotateFilesRequest.Builder

addRequests(int index, AnnotateFileRequest value)

public BatchAnnotateFilesRequest.Builder addRequests(int index, AnnotateFileRequest value)

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Parameters
Name Description
index int
value AnnotateFileRequest
Returns
Type Description
BatchAnnotateFilesRequest.Builder

addRequests(int index, AnnotateFileRequest.Builder builderForValue)

public BatchAnnotateFilesRequest.Builder addRequests(int index, AnnotateFileRequest.Builder builderForValue)

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Parameters
Name Description
index int
builderForValue AnnotateFileRequest.Builder
Returns
Type Description
BatchAnnotateFilesRequest.Builder

addRequestsBuilder()

public AnnotateFileRequest.Builder addRequestsBuilder()

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Returns
Type Description
AnnotateFileRequest.Builder

addRequestsBuilder(int index)

public AnnotateFileRequest.Builder addRequestsBuilder(int index)

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Parameter
Name Description
index int
Returns
Type Description
AnnotateFileRequest.Builder

build()

public BatchAnnotateFilesRequest build()
Returns
Type Description
BatchAnnotateFilesRequest

buildPartial()

public BatchAnnotateFilesRequest buildPartial()
Returns
Type Description
BatchAnnotateFilesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearLabels()

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public BatchAnnotateFilesRequest.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 = 3;

Returns
Type Description
BatchAnnotateFilesRequest.Builder

This builder for chaining.

clearRequests()

public BatchAnnotateFilesRequest.Builder clearRequests()

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Returns
Type Description
BatchAnnotateFilesRequest.Builder

clone()

public BatchAnnotateFilesRequest.Builder clone()
Returns
Type Description
BatchAnnotateFilesRequest.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 BatchAnnotateFilesRequest getDefaultInstanceForType()
Returns
Type Description
BatchAnnotateFilesRequest

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 = 3;

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 = 3;

Returns
Type Description
ByteString

The bytes for parent.

getRequests(int index)

public AnnotateFileRequest getRequests(int index)

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Parameter
Name Description
index int
Returns
Type Description
AnnotateFileRequest

getRequestsBuilder(int index)

public AnnotateFileRequest.Builder getRequestsBuilder(int index)

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Parameter
Name Description
index int
Returns
Type Description
AnnotateFileRequest.Builder

getRequestsBuilderList()

public List<AnnotateFileRequest.Builder> getRequestsBuilderList()

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Returns
Type Description
List<Builder>

getRequestsCount()

public int getRequestsCount()

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Returns
Type Description
int

getRequestsList()

public List<AnnotateFileRequest> getRequestsList()

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Returns
Type Description
List<AnnotateFileRequest>

getRequestsOrBuilder(int index)

public AnnotateFileRequestOrBuilder getRequestsOrBuilder(int index)

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Parameter
Name Description
index int
Returns
Type Description
AnnotateFileRequestOrBuilder

getRequestsOrBuilderList()

public List<? extends AnnotateFileRequestOrBuilder> getRequestsOrBuilderList()

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

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

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(BatchAnnotateFilesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllLabels(Map<String,String> values)

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

putLabels(String key, String value)

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

removeLabels(String key)

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

removeRequests(int index)

public BatchAnnotateFilesRequest.Builder removeRequests(int index)

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Parameter
Name Description
index int
Returns
Type Description
BatchAnnotateFilesRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setParent(String value)

public BatchAnnotateFilesRequest.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 = 3;

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
BatchAnnotateFilesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public BatchAnnotateFilesRequest.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 = 3;

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
BatchAnnotateFilesRequest.Builder

This builder for chaining.

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

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

setRequests(int index, AnnotateFileRequest value)

public BatchAnnotateFilesRequest.Builder setRequests(int index, AnnotateFileRequest value)

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Parameters
Name Description
index int
value AnnotateFileRequest
Returns
Type Description
BatchAnnotateFilesRequest.Builder

setRequests(int index, AnnotateFileRequest.Builder builderForValue)

public BatchAnnotateFilesRequest.Builder setRequests(int index, AnnotateFileRequest.Builder builderForValue)

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

Parameters
Name Description
index int
builderForValue AnnotateFileRequest.Builder
Returns
Type Description
BatchAnnotateFilesRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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