public final class ProcessDocumentRequest extends com.google.protobuf.GeneratedMessageV3 implements ProcessDocumentRequestOrBuilder
Request to process one document.Protobuf type
google.cloud.documentai.v1beta2.ProcessDocumentRequest| Modifier and Type | Class and Description |
|---|---|
static class |
ProcessDocumentRequest.Builder
Request to process one document.
|
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 |
AUTOML_PARAMS_FIELD_NUMBER |
static int |
DOCUMENT_TYPE_FIELD_NUMBER |
static int |
ENTITY_EXTRACTION_PARAMS_FIELD_NUMBER |
static int |
FORM_EXTRACTION_PARAMS_FIELD_NUMBER |
static int |
INPUT_CONFIG_FIELD_NUMBER |
static int |
OCR_PARAMS_FIELD_NUMBER |
static int |
OUTPUT_CONFIG_FIELD_NUMBER |
static int |
PARENT_FIELD_NUMBER |
static int |
TABLE_EXTRACTION_PARAMS_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
AutoMlParams |
getAutomlParams()
Controls AutoML model prediction behavior.
|
AutoMlParamsOrBuilder |
getAutomlParamsOrBuilder()
Controls AutoML model prediction behavior.
|
static ProcessDocumentRequest |
getDefaultInstance() |
ProcessDocumentRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDocumentType()
Specifies a known document type for deeper structure detection.
|
com.google.protobuf.ByteString |
getDocumentTypeBytes()
Specifies a known document type for deeper structure detection.
|
EntityExtractionParams |
getEntityExtractionParams()
Controls entity extraction behavior.
|
EntityExtractionParamsOrBuilder |
getEntityExtractionParamsOrBuilder()
Controls entity extraction behavior.
|
FormExtractionParams |
getFormExtractionParams()
Controls form extraction behavior.
|
FormExtractionParamsOrBuilder |
getFormExtractionParamsOrBuilder()
Controls form extraction behavior.
|
InputConfig |
getInputConfig()
Required.
|
InputConfigOrBuilder |
getInputConfigOrBuilder()
Required.
|
OcrParams |
getOcrParams()
Controls OCR behavior.
|
OcrParamsOrBuilder |
getOcrParamsOrBuilder()
Controls OCR behavior.
|
OutputConfig |
getOutputConfig()
The desired output location.
|
OutputConfigOrBuilder |
getOutputConfigOrBuilder()
The desired output location.
|
String |
getParent()
Target project and location to make a call.
|
com.google.protobuf.ByteString |
getParentBytes()
Target project and location to make a call.
|
com.google.protobuf.Parser<ProcessDocumentRequest> |
getParserForType() |
int |
getSerializedSize() |
TableExtractionParams |
getTableExtractionParams()
Controls table extraction behavior.
|
TableExtractionParamsOrBuilder |
getTableExtractionParamsOrBuilder()
Controls table extraction behavior.
|
boolean |
hasAutomlParams()
Controls AutoML model prediction behavior.
|
boolean |
hasEntityExtractionParams()
Controls entity extraction behavior.
|
boolean |
hasFormExtractionParams()
Controls form extraction behavior.
|
int |
hashCode() |
boolean |
hasInputConfig()
Required.
|
boolean |
hasOcrParams()
Controls OCR behavior.
|
boolean |
hasOutputConfig()
The desired output location.
|
boolean |
hasTableExtractionParams()
Controls table extraction behavior.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ProcessDocumentRequest.Builder |
newBuilder() |
static ProcessDocumentRequest.Builder |
newBuilder(ProcessDocumentRequest prototype) |
ProcessDocumentRequest.Builder |
newBuilderForType() |
protected ProcessDocumentRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ProcessDocumentRequest |
parseDelimitedFrom(InputStream input) |
static ProcessDocumentRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ProcessDocumentRequest |
parseFrom(byte[] data) |
static ProcessDocumentRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ProcessDocumentRequest |
parseFrom(ByteBuffer data) |
static ProcessDocumentRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ProcessDocumentRequest |
parseFrom(com.google.protobuf.ByteString data) |
static ProcessDocumentRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ProcessDocumentRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ProcessDocumentRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ProcessDocumentRequest |
parseFrom(InputStream input) |
static ProcessDocumentRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ProcessDocumentRequest> |
parser() |
ProcessDocumentRequest.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, internalGetMapFieldReflection, 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 PARENT_FIELD_NUMBER
public static final int INPUT_CONFIG_FIELD_NUMBER
public static final int OUTPUT_CONFIG_FIELD_NUMBER
public static final int DOCUMENT_TYPE_FIELD_NUMBER
public static final int TABLE_EXTRACTION_PARAMS_FIELD_NUMBER
public static final int FORM_EXTRACTION_PARAMS_FIELD_NUMBER
public static final int ENTITY_EXTRACTION_PARAMS_FIELD_NUMBER
public static final int OCR_PARAMS_FIELD_NUMBER
public static final int AUTOML_PARAMS_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.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getParent()
Target project and location to make a call.
Format: `projects/{project-id}/locations/{location-id}`.
If no location is specified, a region will be chosen automatically.
This field is only populated when used in ProcessDocument method.
string parent = 9;getParent in interface ProcessDocumentRequestOrBuilderpublic com.google.protobuf.ByteString getParentBytes()
Target project and location to make a call.
Format: `projects/{project-id}/locations/{location-id}`.
If no location is specified, a region will be chosen automatically.
This field is only populated when used in ProcessDocument method.
string parent = 9;getParentBytes in interface ProcessDocumentRequestOrBuilderpublic boolean hasInputConfig()
Required. Information about the input file.
.google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];
hasInputConfig in interface ProcessDocumentRequestOrBuilderpublic InputConfig getInputConfig()
Required. Information about the input file.
.google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];
getInputConfig in interface ProcessDocumentRequestOrBuilderpublic InputConfigOrBuilder getInputConfigOrBuilder()
Required. Information about the input file.
.google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];
getInputConfigOrBuilder in interface ProcessDocumentRequestOrBuilderpublic boolean hasOutputConfig()
The desired output location. This field is only needed in BatchProcessDocumentsRequest.
.google.cloud.documentai.v1beta2.OutputConfig output_config = 2;hasOutputConfig in interface ProcessDocumentRequestOrBuilderpublic OutputConfig getOutputConfig()
The desired output location. This field is only needed in BatchProcessDocumentsRequest.
.google.cloud.documentai.v1beta2.OutputConfig output_config = 2;getOutputConfig in interface ProcessDocumentRequestOrBuilderpublic OutputConfigOrBuilder getOutputConfigOrBuilder()
The desired output location. This field is only needed in BatchProcessDocumentsRequest.
.google.cloud.documentai.v1beta2.OutputConfig output_config = 2;getOutputConfigOrBuilder in interface ProcessDocumentRequestOrBuilderpublic String getDocumentType()
Specifies a known document type for deeper structure detection. Valid values are currently "general" and "invoice". If not provided, "general"\ is used as default. If any other value is given, the request is rejected.
string document_type = 3;getDocumentType in interface ProcessDocumentRequestOrBuilderpublic com.google.protobuf.ByteString getDocumentTypeBytes()
Specifies a known document type for deeper structure detection. Valid values are currently "general" and "invoice". If not provided, "general"\ is used as default. If any other value is given, the request is rejected.
string document_type = 3;getDocumentTypeBytes in interface ProcessDocumentRequestOrBuilderpublic boolean hasTableExtractionParams()
Controls table extraction behavior. If not specified, the system will decide reasonable defaults.
.google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;
hasTableExtractionParams in interface ProcessDocumentRequestOrBuilderpublic TableExtractionParams getTableExtractionParams()
Controls table extraction behavior. If not specified, the system will decide reasonable defaults.
.google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;
getTableExtractionParams in interface ProcessDocumentRequestOrBuilderpublic TableExtractionParamsOrBuilder getTableExtractionParamsOrBuilder()
Controls table extraction behavior. If not specified, the system will decide reasonable defaults.
.google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;
getTableExtractionParamsOrBuilder in interface ProcessDocumentRequestOrBuilderpublic boolean hasFormExtractionParams()
Controls form extraction behavior. If not specified, the system will decide reasonable defaults.
.google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;hasFormExtractionParams in interface ProcessDocumentRequestOrBuilderpublic FormExtractionParams getFormExtractionParams()
Controls form extraction behavior. If not specified, the system will decide reasonable defaults.
.google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;getFormExtractionParams in interface ProcessDocumentRequestOrBuilderpublic FormExtractionParamsOrBuilder getFormExtractionParamsOrBuilder()
Controls form extraction behavior. If not specified, the system will decide reasonable defaults.
.google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;getFormExtractionParamsOrBuilder in interface ProcessDocumentRequestOrBuilderpublic boolean hasEntityExtractionParams()
Controls entity extraction behavior. If not specified, the system will decide reasonable defaults.
.google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;
hasEntityExtractionParams in interface ProcessDocumentRequestOrBuilderpublic EntityExtractionParams getEntityExtractionParams()
Controls entity extraction behavior. If not specified, the system will decide reasonable defaults.
.google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;
getEntityExtractionParams in interface ProcessDocumentRequestOrBuilderpublic EntityExtractionParamsOrBuilder getEntityExtractionParamsOrBuilder()
Controls entity extraction behavior. If not specified, the system will decide reasonable defaults.
.google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;
getEntityExtractionParamsOrBuilder in interface ProcessDocumentRequestOrBuilderpublic boolean hasOcrParams()
Controls OCR behavior. If not specified, the system will decide reasonable defaults.
.google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;hasOcrParams in interface ProcessDocumentRequestOrBuilderpublic OcrParams getOcrParams()
Controls OCR behavior. If not specified, the system will decide reasonable defaults.
.google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;getOcrParams in interface ProcessDocumentRequestOrBuilderpublic OcrParamsOrBuilder getOcrParamsOrBuilder()
Controls OCR behavior. If not specified, the system will decide reasonable defaults.
.google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;getOcrParamsOrBuilder in interface ProcessDocumentRequestOrBuilderpublic boolean hasAutomlParams()
Controls AutoML model prediction behavior. AutoMlParams cannot be used together with other Params.
.google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;hasAutomlParams in interface ProcessDocumentRequestOrBuilderpublic AutoMlParams getAutomlParams()
Controls AutoML model prediction behavior. AutoMlParams cannot be used together with other Params.
.google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;getAutomlParams in interface ProcessDocumentRequestOrBuilderpublic AutoMlParamsOrBuilder getAutomlParamsOrBuilder()
Controls AutoML model prediction behavior. AutoMlParams cannot be used together with other Params.
.google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;getAutomlParamsOrBuilder in interface ProcessDocumentRequestOrBuilderpublic 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 ProcessDocumentRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProcessDocumentRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProcessDocumentRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProcessDocumentRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProcessDocumentRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProcessDocumentRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProcessDocumentRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static ProcessDocumentRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ProcessDocumentRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ProcessDocumentRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ProcessDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ProcessDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ProcessDocumentRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ProcessDocumentRequest.Builder newBuilder()
public static ProcessDocumentRequest.Builder newBuilder(ProcessDocumentRequest prototype)
public ProcessDocumentRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ProcessDocumentRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ProcessDocumentRequest getDefaultInstance()
public static com.google.protobuf.Parser<ProcessDocumentRequest> parser()
public com.google.protobuf.Parser<ProcessDocumentRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ProcessDocumentRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.