public final class ProcessDocumentRequest extends GeneratedMessageV3 implements ProcessDocumentRequestOrBuilder
Request to process one document.
Protobuf type google.cloud.documentai.v1beta2.ProcessDocumentRequest
Static Fields
AUTOML_PARAMS_FIELD_NUMBER
public static final int AUTOML_PARAMS_FIELD_NUMBER
Field Value
DOCUMENT_TYPE_FIELD_NUMBER
public static final int DOCUMENT_TYPE_FIELD_NUMBER
Field Value
public static final int ENTITY_EXTRACTION_PARAMS_FIELD_NUMBER
Field Value
public static final int FORM_EXTRACTION_PARAMS_FIELD_NUMBER
Field Value
public static final int INPUT_CONFIG_FIELD_NUMBER
Field Value
OCR_PARAMS_FIELD_NUMBER
public static final int OCR_PARAMS_FIELD_NUMBER
Field Value
OUTPUT_CONFIG_FIELD_NUMBER
public static final int OUTPUT_CONFIG_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
public static final int TABLE_EXTRACTION_PARAMS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ProcessDocumentRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ProcessDocumentRequest.Builder newBuilder()
Returns
newBuilder(ProcessDocumentRequest prototype)
public static ProcessDocumentRequest.Builder newBuilder(ProcessDocumentRequest prototype)
Parameter
Returns
public static ProcessDocumentRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ProcessDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ProcessDocumentRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ProcessDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ProcessDocumentRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ProcessDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ProcessDocumentRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ProcessDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ProcessDocumentRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ProcessDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ProcessDocumentRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ProcessDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ProcessDocumentRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAutomlParams()
public AutoMlParams getAutomlParams()
Controls AutoML model prediction behavior. AutoMlParams cannot be used
together with other Params.
.google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;
getAutomlParamsOrBuilder()
public AutoMlParamsOrBuilder getAutomlParamsOrBuilder()
Controls AutoML model prediction behavior. AutoMlParams cannot be used
together with other Params.
.google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;
getDefaultInstanceForType()
public ProcessDocumentRequest getDefaultInstanceForType()
Returns
getDocumentType()
public 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;
| Type | Description |
| String | The documentType.
|
getDocumentTypeBytes()
public 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;
| Type | Description |
| ByteString | The bytes for documentType.
|
public EntityExtractionParams getEntityExtractionParams()
Controls entity extraction behavior. If not specified, the system will
decide reasonable defaults.
.google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;
public EntityExtractionParamsOrBuilder getEntityExtractionParamsOrBuilder()
Controls entity extraction behavior. If not specified, the system will
decide reasonable defaults.
.google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;
public FormExtractionParams getFormExtractionParams()
Controls form extraction behavior. If not specified, the system will
decide reasonable defaults.
.google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;
public FormExtractionParamsOrBuilder getFormExtractionParamsOrBuilder()
Controls form extraction behavior. If not specified, the system will
decide reasonable defaults.
.google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;
public InputConfig getInputConfig()
Required. Information about the input file.
.google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];
public InputConfigOrBuilder getInputConfigOrBuilder()
Required. Information about the input file.
.google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];
getOcrParams()
public OcrParams getOcrParams()
Controls OCR behavior. If not specified, the system will decide reasonable
defaults.
.google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;
getOcrParamsOrBuilder()
public OcrParamsOrBuilder getOcrParamsOrBuilder()
Controls OCR behavior. If not specified, the system will decide reasonable
defaults.
.google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;
getOutputConfig()
public OutputConfig getOutputConfig()
Optional. The desired output location. This field is only needed in
BatchProcessDocumentsRequest.
.google.cloud.documentai.v1beta2.OutputConfig output_config = 2 [(.google.api.field_behavior) = OPTIONAL];
getOutputConfigOrBuilder()
public OutputConfigOrBuilder getOutputConfigOrBuilder()
Optional. The desired output location. This field is only needed in
BatchProcessDocumentsRequest.
.google.cloud.documentai.v1beta2.OutputConfig output_config = 2 [(.google.api.field_behavior) = OPTIONAL];
getParent()
public 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;
| Type | Description |
| String | The parent.
|
getParentBytes()
public 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;
getParserForType()
public Parser<ProcessDocumentRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
public TableExtractionParams getTableExtractionParams()
Controls table extraction behavior. If not specified, the system will
decide reasonable defaults.
.google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;
public TableExtractionParamsOrBuilder getTableExtractionParamsOrBuilder()
Controls table extraction behavior. If not specified, the system will
decide reasonable defaults.
.google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasAutomlParams()
public boolean hasAutomlParams()
Controls AutoML model prediction behavior. AutoMlParams cannot be used
together with other Params.
.google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;
| Type | Description |
| boolean | Whether the automlParams field is set.
|
public boolean hasEntityExtractionParams()
Controls entity extraction behavior. If not specified, the system will
decide reasonable defaults.
.google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;
| Type | Description |
| boolean | Whether the entityExtractionParams field is set.
|
public boolean hasFormExtractionParams()
Controls form extraction behavior. If not specified, the system will
decide reasonable defaults.
.google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;
| Type | Description |
| boolean | Whether the formExtractionParams field is set.
|
public boolean hasInputConfig()
Required. Information about the input file.
.google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the inputConfig field is set.
|
hasOcrParams()
public boolean hasOcrParams()
Controls OCR behavior. If not specified, the system will decide reasonable
defaults.
.google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;
| Type | Description |
| boolean | Whether the ocrParams field is set.
|
hasOutputConfig()
public boolean hasOutputConfig()
Optional. The desired output location. This field is only needed in
BatchProcessDocumentsRequest.
.google.cloud.documentai.v1beta2.OutputConfig output_config = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the outputConfig field is set.
|
public boolean hasTableExtractionParams()
Controls table extraction behavior. If not specified, the system will
decide reasonable defaults.
.google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;
| Type | Description |
| boolean | Whether the tableExtractionParams field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ProcessDocumentRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ProcessDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ProcessDocumentRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
