public final class BatchProcessRequest extends GeneratedMessageV3 implements BatchProcessRequestOrBuilder
Request message for
BatchProcessDocuments.
Protobuf type google.cloud.documentai.v1beta3.BatchProcessRequest
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
DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
public static final int DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int INPUT_CONFIGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int INPUT_DOCUMENTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OUTPUT_CONFIG_FIELD_NUMBER
public static final int OUTPUT_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROCESS_OPTIONS_FIELD_NUMBER
public static final int PROCESS_OPTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SKIP_HUMAN_REVIEW_FIELD_NUMBER
public static final int SKIP_HUMAN_REVIEW_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static BatchProcessRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BatchProcessRequest.Builder newBuilder()
newBuilder(BatchProcessRequest prototype)
public static BatchProcessRequest.Builder newBuilder(BatchProcessRequest prototype)
public static BatchProcessRequest parseDelimitedFrom(InputStream input)
public static BatchProcessRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BatchProcessRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchProcessRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BatchProcessRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchProcessRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchProcessRequest parseFrom(CodedInputStream input)
public static BatchProcessRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchProcessRequest parseFrom(InputStream input)
public static BatchProcessRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BatchProcessRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchProcessRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BatchProcessRequest> 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) and 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 = 9 [(.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 BatchProcessRequest getDefaultInstanceForType()
getDocumentOutputConfig()
public DocumentOutputConfig getDocumentOutputConfig()
The output configuration for the
BatchProcessDocuments
method.
.google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;
getDocumentOutputConfigOrBuilder()
public DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()
The output configuration for the
BatchProcessDocuments
method.
.google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;
public BatchProcessRequest.BatchInputConfig getInputConfigs(int index)
The input config for each single document in the batch process.
repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];
| Parameter |
| Name |
Description |
index |
int
|
public int getInputConfigsCount()
The input config for each single document in the batch process.
repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];
| Returns |
| Type |
Description |
int |
|
public List<BatchProcessRequest.BatchInputConfig> getInputConfigsList()
The input config for each single document in the batch process.
repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];
public BatchProcessRequest.BatchInputConfigOrBuilder getInputConfigsOrBuilder(int index)
The input config for each single document in the batch process.
repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends BatchProcessRequest.BatchInputConfigOrBuilder> getInputConfigsOrBuilderList()
The input config for each single document in the batch process.
repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfigOrBuilder> |
|
public BatchDocumentsInputConfig getInputDocuments()
The input documents for the
BatchProcessDocuments
method.
.google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;
public BatchDocumentsInputConfigOrBuilder getInputDocumentsOrBuilder()
The input documents for the
BatchProcessDocuments
method.
.google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;
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) and 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 = 9 [(.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) and 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 = 9 [(.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) and 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 = 9 [(.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) and 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 = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getName()
Required. The resource name of
Processor or
ProcessorVersion.
Format: projects/{project}/locations/{location}/processors/{processor},
or
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. The resource name of
Processor or
ProcessorVersion.
Format: projects/{project}/locations/{location}/processors/{processor},
or
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getOutputConfig() (deprecated)
public BatchProcessRequest.BatchOutputConfig getOutputConfig()
Deprecated. google.cloud.documentai.v1beta3.BatchProcessRequest.output_config is deprecated.
See google/cloud/documentai/v1beta3/document_processor_service.proto;l=580
The overall output config for batch process.
.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];
getOutputConfigOrBuilder() (deprecated)
public BatchProcessRequest.BatchOutputConfigOrBuilder getOutputConfigOrBuilder()
The overall output config for batch process.
.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];
getParserForType()
public Parser<BatchProcessRequest> getParserForType()
Overrides
getProcessOptions()
public ProcessOptions getProcessOptions()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
getProcessOptionsOrBuilder()
public ProcessOptionsOrBuilder getProcessOptionsOrBuilder()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSkipHumanReview()
public boolean getSkipHumanReview()
Whether human review should be skipped for this request. Default to
false.
bool skip_human_review = 4;
| Returns |
| Type |
Description |
boolean |
The skipHumanReview.
|
hasDocumentOutputConfig()
public boolean hasDocumentOutputConfig()
The output configuration for the
BatchProcessDocuments
method.
.google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;
| Returns |
| Type |
Description |
boolean |
Whether the documentOutputConfig field is set.
|
public boolean hasInputDocuments()
The input documents for the
BatchProcessDocuments
method.
.google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;
| Returns |
| Type |
Description |
boolean |
Whether the inputDocuments field is set.
|
hasOutputConfig() (deprecated)
public boolean hasOutputConfig()
Deprecated. google.cloud.documentai.v1beta3.BatchProcessRequest.output_config is deprecated.
See google/cloud/documentai/v1beta3/document_processor_service.proto;l=580
The overall output config for batch process.
.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];
| Returns |
| Type |
Description |
boolean |
Whether the outputConfig field is set.
|
hasProcessOptions()
public boolean hasProcessOptions()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
| Returns |
| Type |
Description |
boolean |
Whether the processOptions field is set.
|
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 BatchProcessRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchProcessRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public BatchProcessRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
