public final class BatchProcessRequest extends com.google.protobuf.GeneratedMessageV3 implements BatchProcessRequestOrBuilder
Request message for [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].Protobuf type
google.cloud.documentai.v1beta3.BatchProcessRequest| Modifier and Type | Class and Description |
|---|---|
static class |
BatchProcessRequest.BatchInputConfig
Deprecated.
|
static interface |
BatchProcessRequest.BatchInputConfigOrBuilder
Deprecated.
|
static class |
BatchProcessRequest.BatchOutputConfig
Deprecated.
|
static interface |
BatchProcessRequest.BatchOutputConfigOrBuilder
Deprecated.
|
static class |
BatchProcessRequest.Builder
Request message for
[BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER |
static int |
INPUT_CONFIGS_FIELD_NUMBER |
static int |
INPUT_DOCUMENTS_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
OUTPUT_CONFIG_FIELD_NUMBER |
static int |
PROCESS_OPTIONS_FIELD_NUMBER |
static int |
SKIP_HUMAN_REVIEW_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
Optional.
|
boolean |
equals(Object obj) |
static BatchProcessRequest |
getDefaultInstance() |
BatchProcessRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
DocumentOutputConfig |
getDocumentOutputConfig()
The output configuration for the
[BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
method.
|
DocumentOutputConfigOrBuilder |
getDocumentOutputConfigOrBuilder()
The output configuration for the
[BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
method.
|
BatchProcessRequest.BatchInputConfig |
getInputConfigs(int index)
Deprecated.
|
int |
getInputConfigsCount()
Deprecated.
|
List<BatchProcessRequest.BatchInputConfig> |
getInputConfigsList()
Deprecated.
|
BatchProcessRequest.BatchInputConfigOrBuilder |
getInputConfigsOrBuilder(int index)
Deprecated.
|
List<? extends BatchProcessRequest.BatchInputConfigOrBuilder> |
getInputConfigsOrBuilderList()
Deprecated.
|
BatchDocumentsInputConfig |
getInputDocuments()
The input documents for the
[BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
method.
|
BatchDocumentsInputConfigOrBuilder |
getInputDocumentsOrBuilder()
The input documents for the
[BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
method.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Optional.
|
Map<String,String> |
getLabelsMap()
Optional.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
Optional.
|
String |
getLabelsOrThrow(String key)
Optional.
|
String |
getName()
Required.
|
com.google.protobuf.ByteString |
getNameBytes()
Required.
|
BatchProcessRequest.BatchOutputConfig |
getOutputConfig()
Deprecated.
google.cloud.documentai.v1beta3.BatchProcessRequest.output_config is deprecated.
See google/cloud/documentai/v1beta3/document_processor_service.proto;l=580
|
BatchProcessRequest.BatchOutputConfigOrBuilder |
getOutputConfigOrBuilder()
Deprecated.
|
com.google.protobuf.Parser<BatchProcessRequest> |
getParserForType() |
ProcessOptions |
getProcessOptions()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7; |
ProcessOptionsOrBuilder |
getProcessOptionsOrBuilder()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7; |
int |
getSerializedSize() |
boolean |
getSkipHumanReview()
Whether human review should be skipped for this request.
|
boolean |
hasDocumentOutputConfig()
The output configuration for the
[BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
method.
|
int |
hashCode() |
boolean |
hasInputDocuments()
The input documents for the
[BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
method.
|
boolean |
hasOutputConfig()
Deprecated.
google.cloud.documentai.v1beta3.BatchProcessRequest.output_config is deprecated.
See google/cloud/documentai/v1beta3/document_processor_service.proto;l=580
|
boolean |
hasProcessOptions()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7; |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static BatchProcessRequest.Builder |
newBuilder() |
static BatchProcessRequest.Builder |
newBuilder(BatchProcessRequest prototype) |
BatchProcessRequest.Builder |
newBuilderForType() |
protected BatchProcessRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static BatchProcessRequest |
parseDelimitedFrom(InputStream input) |
static BatchProcessRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BatchProcessRequest |
parseFrom(byte[] data) |
static BatchProcessRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BatchProcessRequest |
parseFrom(ByteBuffer data) |
static BatchProcessRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BatchProcessRequest |
parseFrom(com.google.protobuf.ByteString data) |
static BatchProcessRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BatchProcessRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static BatchProcessRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BatchProcessRequest |
parseFrom(InputStream input) |
static BatchProcessRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<BatchProcessRequest> |
parser() |
BatchProcessRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int INPUT_CONFIGS_FIELD_NUMBER
public static final int OUTPUT_CONFIG_FIELD_NUMBER
public static final int INPUT_DOCUMENTS_FIELD_NUMBER
public static final int DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
public static final int SKIP_HUMAN_REVIEW_FIELD_NUMBER
public static final int PROCESS_OPTIONS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Required. The resource name of
[Processor][google.cloud.documentai.v1beta3.Processor] or
[ProcessorVersion][google.cloud.documentai.v1beta3.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) = { ... }
getName in interface BatchProcessRequestOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Required. The resource name of
[Processor][google.cloud.documentai.v1beta3.Processor] or
[ProcessorVersion][google.cloud.documentai.v1beta3.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) = { ... }
getNameBytes in interface BatchProcessRequestOrBuilder@Deprecated 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];
getInputConfigsList in interface BatchProcessRequestOrBuilder@Deprecated 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];
getInputConfigsOrBuilderList in interface BatchProcessRequestOrBuilder@Deprecated 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];
getInputConfigsCount in interface BatchProcessRequestOrBuilder@Deprecated 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];
getInputConfigs in interface BatchProcessRequestOrBuilder@Deprecated 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];
getInputConfigsOrBuilder in interface BatchProcessRequestOrBuilder@Deprecated public boolean hasOutputConfig()
The overall output config for batch process.
.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];
hasOutputConfig in interface BatchProcessRequestOrBuilder@Deprecated public BatchProcessRequest.BatchOutputConfig getOutputConfig()
The overall output config for batch process.
.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];
getOutputConfig in interface BatchProcessRequestOrBuilder@Deprecated public BatchProcessRequest.BatchOutputConfigOrBuilder getOutputConfigOrBuilder()
The overall output config for batch process.
.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];
getOutputConfigOrBuilder in interface BatchProcessRequestOrBuilderpublic boolean hasInputDocuments()
The input documents for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.
.google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;hasInputDocuments in interface BatchProcessRequestOrBuilderpublic BatchDocumentsInputConfig getInputDocuments()
The input documents for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.
.google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;getInputDocuments in interface BatchProcessRequestOrBuilderpublic BatchDocumentsInputConfigOrBuilder getInputDocumentsOrBuilder()
The input documents for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.
.google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;getInputDocumentsOrBuilder in interface BatchProcessRequestOrBuilderpublic boolean hasDocumentOutputConfig()
The output configuration for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.
.google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;hasDocumentOutputConfig in interface BatchProcessRequestOrBuilderpublic DocumentOutputConfig getDocumentOutputConfig()
The output configuration for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.
.google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;getDocumentOutputConfig in interface BatchProcessRequestOrBuilderpublic DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()
The output configuration for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.
.google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;getDocumentOutputConfigOrBuilder in interface BatchProcessRequestOrBuilderpublic boolean getSkipHumanReview()
Whether human review should be skipped for this request. Default to `false`.
bool skip_human_review = 4;getSkipHumanReview in interface BatchProcessRequestOrBuilderpublic boolean hasProcessOptions()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;hasProcessOptions in interface BatchProcessRequestOrBuilderpublic ProcessOptions getProcessOptions()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;getProcessOptions in interface BatchProcessRequestOrBuilderpublic ProcessOptionsOrBuilder getProcessOptionsOrBuilder()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;getProcessOptionsOrBuilder in interface BatchProcessRequestOrBuilderpublic int getLabelsCount()
BatchProcessRequestOrBuilderOptional. 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];getLabelsCount in interface BatchProcessRequestOrBuilderpublic 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];containsLabels in interface BatchProcessRequestOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface BatchProcessRequestOrBuilderpublic 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];getLabelsMap in interface BatchProcessRequestOrBuilderpublic 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];getLabelsOrDefault in interface BatchProcessRequestOrBuilderpublic 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];getLabelsOrThrow in interface BatchProcessRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static BatchProcessRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BatchProcessRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BatchProcessRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BatchProcessRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BatchProcessRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BatchProcessRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BatchProcessRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static BatchProcessRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static BatchProcessRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static BatchProcessRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static BatchProcessRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static BatchProcessRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic BatchProcessRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static BatchProcessRequest.Builder newBuilder()
public static BatchProcessRequest.Builder newBuilder(BatchProcessRequest prototype)
public BatchProcessRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected BatchProcessRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static BatchProcessRequest getDefaultInstance()
public static com.google.protobuf.Parser<BatchProcessRequest> parser()
public com.google.protobuf.Parser<BatchProcessRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public BatchProcessRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.