Class BatchAnnotateFilesRequest.Builder (3.33.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
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.cloud.vision.v1.AnnotateFileRequest>
Returns
TypeDescription
BatchAnnotateFilesRequest.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchAnnotateFilesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueAnnotateFileRequest
Returns
TypeDescription
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
NameDescription
builderForValueAnnotateFileRequest.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueAnnotateFileRequest
Returns
TypeDescription
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
NameDescription
indexint
builderForValueAnnotateFileRequest.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
AnnotateFileRequest.Builder

build()

public BatchAnnotateFilesRequest build()
Returns
TypeDescription
BatchAnnotateFilesRequest

buildPartial()

public BatchAnnotateFilesRequest buildPartial()
Returns
TypeDescription
BatchAnnotateFilesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearLabels()

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

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchAnnotateFilesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
BatchAnnotateFilesRequest.Builder

clone()

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

getDefaultInstanceForType()

public BatchAnnotateFilesRequest getDefaultInstanceForType()
Returns
TypeDescription
BatchAnnotateFilesRequest

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>

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

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

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

public BatchAnnotateFilesRequest.Builder mergeFrom(BatchAnnotateFilesRequest other)
Parameter
NameDescription
otherBatchAnnotateFilesRequest
Returns
TypeDescription
BatchAnnotateFilesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchAnnotateFilesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
BatchAnnotateFilesRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BatchAnnotateFilesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
indexint
valueAnnotateFileRequest
Returns
TypeDescription
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
NameDescription
indexint
builderForValueAnnotateFileRequest.Builder
Returns
TypeDescription
BatchAnnotateFilesRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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