com.google.cloud.documentai.v1beta2

Interface ProcessDocumentRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ProcessDocumentRequest, ProcessDocumentRequest.Builder

public interface ProcessDocumentRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
AutoMlParams	getAutomlParams() Controls AutoML model prediction behavior.
AutoMlParamsOrBuilder	getAutomlParamsOrBuilder() Controls AutoML model prediction behavior.
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.
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.
boolean	hasInputConfig() Required.
boolean	hasOcrParams() Controls OCR behavior.
boolean	hasOutputConfig() The desired output location.
boolean	hasTableExtractionParams() Controls table extraction behavior.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

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;

Returns:

The parent.

getParentBytes

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;

Returns:

The bytes for parent.

hasInputConfig

boolean hasInputConfig()

 Required. Information about the input file.
 

.google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the inputConfig field is set.

getInputConfig

InputConfig getInputConfig()

 Required. Information about the input file.
 

.google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The inputConfig.

getInputConfigOrBuilder

InputConfigOrBuilder getInputConfigOrBuilder()

 Required. Information about the input file.
 

.google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];

hasOutputConfig

boolean hasOutputConfig()

 The desired output location. This field is only needed in
 BatchProcessDocumentsRequest.
 

.google.cloud.documentai.v1beta2.OutputConfig output_config = 2;

Returns:

Whether the outputConfig field is set.

getOutputConfig

OutputConfig getOutputConfig()

 The desired output location. This field is only needed in
 BatchProcessDocumentsRequest.
 

.google.cloud.documentai.v1beta2.OutputConfig output_config = 2;

Returns:

The outputConfig.

getOutputConfigOrBuilder

OutputConfigOrBuilder getOutputConfigOrBuilder()

 The desired output location. This field is only needed in
 BatchProcessDocumentsRequest.
 

.google.cloud.documentai.v1beta2.OutputConfig output_config = 2;

getDocumentType

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;

Returns:

The documentType.

getDocumentTypeBytes

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;

Returns:

The bytes for documentType.

hasTableExtractionParams

boolean hasTableExtractionParams()

 Controls table extraction behavior. If not specified, the system will
 decide reasonable defaults.
 

.google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;

Returns:

Whether the tableExtractionParams field is set.

getTableExtractionParams

TableExtractionParams getTableExtractionParams()

 Controls table extraction behavior. If not specified, the system will
 decide reasonable defaults.
 

.google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;

Returns:

The tableExtractionParams.

getTableExtractionParamsOrBuilder

TableExtractionParamsOrBuilder getTableExtractionParamsOrBuilder()

 Controls table extraction behavior. If not specified, the system will
 decide reasonable defaults.
 

.google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;

hasFormExtractionParams

boolean hasFormExtractionParams()

 Controls form extraction behavior. If not specified, the system will
 decide reasonable defaults.
 

.google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;

Returns:

Whether the formExtractionParams field is set.

getFormExtractionParams

FormExtractionParams getFormExtractionParams()

 Controls form extraction behavior. If not specified, the system will
 decide reasonable defaults.
 

.google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;

Returns:

The formExtractionParams.

getFormExtractionParamsOrBuilder

FormExtractionParamsOrBuilder getFormExtractionParamsOrBuilder()

 Controls form extraction behavior. If not specified, the system will
 decide reasonable defaults.
 

.google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;

hasEntityExtractionParams

boolean hasEntityExtractionParams()

 Controls entity extraction behavior. If not specified, the system will
 decide reasonable defaults.
 

.google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;

Returns:

Whether the entityExtractionParams field is set.

getEntityExtractionParams

EntityExtractionParams getEntityExtractionParams()

 Controls entity extraction behavior. If not specified, the system will
 decide reasonable defaults.
 

.google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;

Returns:

The entityExtractionParams.

getEntityExtractionParamsOrBuilder

EntityExtractionParamsOrBuilder getEntityExtractionParamsOrBuilder()

 Controls entity extraction behavior. If not specified, the system will
 decide reasonable defaults.
 

.google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;

hasOcrParams

boolean hasOcrParams()

 Controls OCR behavior. If not specified, the system will decide reasonable
 defaults.
 

.google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;

Returns:

Whether the ocrParams field is set.

getOcrParams

OcrParams getOcrParams()

 Controls OCR behavior. If not specified, the system will decide reasonable
 defaults.
 

.google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;

Returns:

The ocrParams.

getOcrParamsOrBuilder

OcrParamsOrBuilder getOcrParamsOrBuilder()

 Controls OCR behavior. If not specified, the system will decide reasonable
 defaults.
 

.google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;

hasAutomlParams

boolean hasAutomlParams()

 Controls AutoML model prediction behavior. AutoMlParams cannot be used
 together with other Params.
 

.google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;

Returns:

Whether the automlParams field is set.

getAutomlParams

AutoMlParams getAutomlParams()

 Controls AutoML model prediction behavior. AutoMlParams cannot be used
 together with other Params.
 

.google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;

Returns:

The automlParams.

getAutomlParamsOrBuilder

AutoMlParamsOrBuilder getAutomlParamsOrBuilder()

 Controls AutoML model prediction behavior. AutoMlParams cannot be used
 together with other Params.
 

.google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;