Class BatchAnnotateImagesRequest.Builder (3.40.0)

public static final class BatchAnnotateImagesRequest.Builder extends GeneratedMessageV3.Builder<BatchAnnotateImagesRequest.Builder> implements BatchAnnotateImagesRequestOrBuilder

Multiple image annotation requests are batched into a single service call.

Protobuf type google.cloud.vision.v1.BatchAnnotateImagesRequest

Static Methods

getDescriptor()

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

Methods

addAllRequests(Iterable<? extends AnnotateImageRequest> values)

public BatchAnnotateImagesRequest.Builder addAllRequests(Iterable<? extends AnnotateImageRequest> values)

Required. Individual image annotation requests for this batch.

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

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addRequests(AnnotateImageRequest value)

public BatchAnnotateImagesRequest.Builder addRequests(AnnotateImageRequest value)

Required. Individual image annotation requests for this batch.

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

Parameter
Name Description
value AnnotateImageRequest
Returns
Type Description
BatchAnnotateImagesRequest.Builder

addRequests(AnnotateImageRequest.Builder builderForValue)

public BatchAnnotateImagesRequest.Builder addRequests(AnnotateImageRequest.Builder builderForValue)

Required. Individual image annotation requests for this batch.

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

Parameter
Name Description
builderForValue AnnotateImageRequest.Builder
Returns
Type Description
BatchAnnotateImagesRequest.Builder

addRequests(int index, AnnotateImageRequest value)

public BatchAnnotateImagesRequest.Builder addRequests(int index, AnnotateImageRequest value)

Required. Individual image annotation requests for this batch.

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

Parameters
Name Description
index int
value AnnotateImageRequest
Returns
Type Description
BatchAnnotateImagesRequest.Builder

addRequests(int index, AnnotateImageRequest.Builder builderForValue)

public BatchAnnotateImagesRequest.Builder addRequests(int index, AnnotateImageRequest.Builder builderForValue)

Required. Individual image annotation requests for this batch.

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

Parameters
Name Description
index int
builderForValue AnnotateImageRequest.Builder
Returns
Type Description
BatchAnnotateImagesRequest.Builder

addRequestsBuilder()

public AnnotateImageRequest.Builder addRequestsBuilder()

Required. Individual image annotation requests for this batch.

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

Returns
Type Description
AnnotateImageRequest.Builder

addRequestsBuilder(int index)

public AnnotateImageRequest.Builder addRequestsBuilder(int index)

Required. Individual image annotation requests for this batch.

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

Parameter
Name Description
index int
Returns
Type Description
AnnotateImageRequest.Builder

build()

public BatchAnnotateImagesRequest build()
Returns
Type Description
BatchAnnotateImagesRequest

buildPartial()

public BatchAnnotateImagesRequest buildPartial()
Returns
Type Description
BatchAnnotateImagesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearLabels()

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

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

This builder for chaining.

clearRequests()

public BatchAnnotateImagesRequest.Builder clearRequests()

Required. Individual image annotation requests for this batch.

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

Returns
Type Description
BatchAnnotateImagesRequest.Builder

clone()

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

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 AnnotateImageRequest getRequests(int index)

Required. Individual image annotation requests for this batch.

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

Parameter
Name Description
index int
Returns
Type Description
AnnotateImageRequest

getRequestsBuilder(int index)

public AnnotateImageRequest.Builder getRequestsBuilder(int index)

Required. Individual image annotation requests for this batch.

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

Parameter
Name Description
index int
Returns
Type Description
AnnotateImageRequest.Builder

getRequestsBuilderList()

public List<AnnotateImageRequest.Builder> getRequestsBuilderList()

Required. Individual image annotation requests for this batch.

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

Returns
Type Description
List<Builder>

getRequestsCount()

public int getRequestsCount()

Required. Individual image annotation requests for this batch.

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

Returns
Type Description
int

getRequestsList()

public List<AnnotateImageRequest> getRequestsList()

Required. Individual image annotation requests for this batch.

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

Returns
Type Description
List<AnnotateImageRequest>

getRequestsOrBuilder(int index)

public AnnotateImageRequestOrBuilder getRequestsOrBuilder(int index)

Required. Individual image annotation requests for this batch.

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

Parameter
Name Description
index int
Returns
Type Description
AnnotateImageRequestOrBuilder

getRequestsOrBuilderList()

public List<? extends AnnotateImageRequestOrBuilder> getRequestsOrBuilderList()

Required. Individual image annotation requests for this batch.

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

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

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

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllLabels(Map<String,String> values)

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

putLabels(String key, String value)

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

removeLabels(String key)

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

removeRequests(int index)

public BatchAnnotateImagesRequest.Builder removeRequests(int index)

Required. Individual image annotation requests for this batch.

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

Parameter
Name Description
index int
Returns
Type Description
BatchAnnotateImagesRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setParent(String value)

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

This builder for chaining.

setParentBytes(ByteString value)

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

This builder for chaining.

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

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

setRequests(int index, AnnotateImageRequest value)

public BatchAnnotateImagesRequest.Builder setRequests(int index, AnnotateImageRequest value)

Required. Individual image annotation requests for this batch.

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

Parameters
Name Description
index int
value AnnotateImageRequest
Returns
Type Description
BatchAnnotateImagesRequest.Builder

setRequests(int index, AnnotateImageRequest.Builder builderForValue)

public BatchAnnotateImagesRequest.Builder setRequests(int index, AnnotateImageRequest.Builder builderForValue)

Required. Individual image annotation requests for this batch.

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

Parameters
Name Description
index int
builderForValue AnnotateImageRequest.Builder
Returns
Type Description
BatchAnnotateImagesRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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