Class AsyncBatchAnnotateImagesRequest.Builder (3.35.0)

public static final class AsyncBatchAnnotateImagesRequest.Builder extends GeneratedMessageV3.Builder<AsyncBatchAnnotateImagesRequest.Builder> implements AsyncBatchAnnotateImagesRequestOrBuilder

Request for async image annotation for a list of images.

Protobuf type google.cloud.vision.v1.AsyncBatchAnnotateImagesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllRequests(Iterable<? extends AnnotateImageRequest> values)

public AsyncBatchAnnotateImagesRequest.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
NameDescription
valuesIterable<? extends com.google.cloud.vision.v1.AnnotateImageRequest>
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AsyncBatchAnnotateImagesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder
Overrides

addRequests(AnnotateImageRequest value)

public AsyncBatchAnnotateImagesRequest.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
NameDescription
valueAnnotateImageRequest
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

addRequests(AnnotateImageRequest.Builder builderForValue)

public AsyncBatchAnnotateImagesRequest.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
NameDescription
builderForValueAnnotateImageRequest.Builder
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

addRequests(int index, AnnotateImageRequest value)

public AsyncBatchAnnotateImagesRequest.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
NameDescription
indexint
valueAnnotateImageRequest
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

addRequests(int index, AnnotateImageRequest.Builder builderForValue)

public AsyncBatchAnnotateImagesRequest.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
NameDescription
indexint
builderForValueAnnotateImageRequest.Builder
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
AnnotateImageRequest.Builder

build()

public AsyncBatchAnnotateImagesRequest build()
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest

buildPartial()

public AsyncBatchAnnotateImagesRequest buildPartial()
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest

clear()

public AsyncBatchAnnotateImagesRequest.Builder clear()
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public AsyncBatchAnnotateImagesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder
Overrides

clearLabels()

public AsyncBatchAnnotateImagesRequest.Builder clearLabels()
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public AsyncBatchAnnotateImagesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder
Overrides

clearOutputConfig()

public AsyncBatchAnnotateImagesRequest.Builder clearOutputConfig()

Required. The desired output location and metadata (e.g. format).

.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

clearParent()

public AsyncBatchAnnotateImagesRequest.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
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

This builder for chaining.

clearRequests()

public AsyncBatchAnnotateImagesRequest.Builder clearRequests()

Required. Individual image annotation requests for this batch.

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

Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

clone()

public AsyncBatchAnnotateImagesRequest.Builder clone()
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.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
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public AsyncBatchAnnotateImagesRequest getDefaultInstanceForType()
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getOutputConfig()

public OutputConfig getOutputConfig()

Required. The desired output location and metadata (e.g. format).

.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
OutputConfig

The outputConfig.

getOutputConfigBuilder()

public OutputConfig.Builder getOutputConfigBuilder()

Required. The desired output location and metadata (e.g. format).

.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
OutputConfig.Builder

getOutputConfigOrBuilder()

public OutputConfigOrBuilder getOutputConfigOrBuilder()

Required. The desired output location and metadata (e.g. format).

.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
OutputConfigOrBuilder

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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.vision.v1.AnnotateImageRequestOrBuilder>

hasOutputConfig()

public boolean hasOutputConfig()

Required. The desired output location and metadata (e.g. format).

.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the outputConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AsyncBatchAnnotateImagesRequest other)

public AsyncBatchAnnotateImagesRequest.Builder mergeFrom(AsyncBatchAnnotateImagesRequest other)
Parameter
NameDescription
otherAsyncBatchAnnotateImagesRequest
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AsyncBatchAnnotateImagesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AsyncBatchAnnotateImagesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder
Overrides

mergeOutputConfig(OutputConfig value)

public AsyncBatchAnnotateImagesRequest.Builder mergeOutputConfig(OutputConfig value)

Required. The desired output location and metadata (e.g. format).

.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueOutputConfig
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AsyncBatchAnnotateImagesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder
Overrides

putAllLabels(Map<String,String> values)

public AsyncBatchAnnotateImagesRequest.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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

putLabels(String key, String value)

public AsyncBatchAnnotateImagesRequest.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
NameDescription
keyString
valueString
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

removeLabels(String key)

public AsyncBatchAnnotateImagesRequest.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
NameDescription
keyString
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

removeRequests(int index)

public AsyncBatchAnnotateImagesRequest.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
NameDescription
indexint
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AsyncBatchAnnotateImagesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder
Overrides

setOutputConfig(OutputConfig value)

public AsyncBatchAnnotateImagesRequest.Builder setOutputConfig(OutputConfig value)

Required. The desired output location and metadata (e.g. format).

.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueOutputConfig
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

setOutputConfig(OutputConfig.Builder builderForValue)

public AsyncBatchAnnotateImagesRequest.Builder setOutputConfig(OutputConfig.Builder builderForValue)

Required. The desired output location and metadata (e.g. format).

.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueOutputConfig.Builder
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

setParent(String value)

public AsyncBatchAnnotateImagesRequest.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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public AsyncBatchAnnotateImagesRequest.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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

This builder for chaining.

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

public AsyncBatchAnnotateImagesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder
Overrides

setRequests(int index, AnnotateImageRequest value)

public AsyncBatchAnnotateImagesRequest.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
NameDescription
indexint
valueAnnotateImageRequest
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

setRequests(int index, AnnotateImageRequest.Builder builderForValue)

public AsyncBatchAnnotateImagesRequest.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
NameDescription
indexint
builderForValueAnnotateImageRequest.Builder
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final AsyncBatchAnnotateImagesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AsyncBatchAnnotateImagesRequest.Builder
Overrides