public final class BatchAnnotateFilesRequest extends GeneratedMessageV3 implements BatchAnnotateFilesRequestOrBuilder
A list of requests to annotate files using the BatchAnnotateFiles API.
Protobuf type google.cloud.vision.v1.BatchAnnotateFilesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUESTS_FIELD_NUMBER
public static final int REQUESTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static BatchAnnotateFilesRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BatchAnnotateFilesRequest.Builder newBuilder()
newBuilder(BatchAnnotateFilesRequest prototype)
public static BatchAnnotateFilesRequest.Builder newBuilder(BatchAnnotateFilesRequest prototype)
public static BatchAnnotateFilesRequest parseDelimitedFrom(InputStream input)
public static BatchAnnotateFilesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BatchAnnotateFilesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchAnnotateFilesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BatchAnnotateFilesRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchAnnotateFilesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchAnnotateFilesRequest parseFrom(CodedInputStream input)
public static BatchAnnotateFilesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchAnnotateFilesRequest parseFrom(InputStream input)
public static BatchAnnotateFilesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BatchAnnotateFilesRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchAnnotateFilesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BatchAnnotateFilesRequest> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public BatchAnnotateFilesRequest getDefaultInstanceForType()
getLabels() (deprecated)
public Map<String,String> getLabels()
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];
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];
| 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 |
|
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.
|
getParserForType()
public Parser<BatchAnnotateFilesRequest> getParserForType()
Overrides
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
|
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];
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
|
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> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BatchAnnotateFilesRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchAnnotateFilesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public BatchAnnotateFilesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
