Class ProcessDocumentRequest (2.23.0)

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
TypeDescription
int

DOCUMENT_TYPE_FIELD_NUMBER

public static final int DOCUMENT_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

ENTITY_EXTRACTION_PARAMS_FIELD_NUMBER

public static final int ENTITY_EXTRACTION_PARAMS_FIELD_NUMBER
Field Value
TypeDescription
int

FORM_EXTRACTION_PARAMS_FIELD_NUMBER

public static final int FORM_EXTRACTION_PARAMS_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_CONFIG_FIELD_NUMBER

public static final int INPUT_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

OCR_PARAMS_FIELD_NUMBER

public static final int OCR_PARAMS_FIELD_NUMBER
Field Value
TypeDescription
int

OUTPUT_CONFIG_FIELD_NUMBER

public static final int OUTPUT_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

TABLE_EXTRACTION_PARAMS_FIELD_NUMBER

public static final int TABLE_EXTRACTION_PARAMS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ProcessDocumentRequest getDefaultInstance()
Returns
TypeDescription
ProcessDocumentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ProcessDocumentRequest.Builder newBuilder()
Returns
TypeDescription
ProcessDocumentRequest.Builder

newBuilder(ProcessDocumentRequest prototype)

public static ProcessDocumentRequest.Builder newBuilder(ProcessDocumentRequest prototype)
Parameter
NameDescription
prototypeProcessDocumentRequest
Returns
TypeDescription
ProcessDocumentRequest.Builder

parseDelimitedFrom(InputStream input)

public static ProcessDocumentRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProcessDocumentRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ProcessDocumentRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ProcessDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProcessDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProcessDocumentRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ProcessDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProcessDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProcessDocumentRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ProcessDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ProcessDocumentRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProcessDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ProcessDocumentRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ProcessDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProcessDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ProcessDocumentRequest> parser()
Returns
TypeDescription
Parser<ProcessDocumentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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;

Returns
TypeDescription
AutoMlParams

The automlParams.

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;

Returns
TypeDescription
AutoMlParamsOrBuilder

getDefaultInstanceForType()

public ProcessDocumentRequest getDefaultInstanceForType()
Returns
TypeDescription
ProcessDocumentRequest

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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for documentType.

getEntityExtractionParams()

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;

Returns
TypeDescription
EntityExtractionParams

The entityExtractionParams.

getEntityExtractionParamsOrBuilder()

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;

Returns
TypeDescription
EntityExtractionParamsOrBuilder

getFormExtractionParams()

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;

Returns
TypeDescription
FormExtractionParams

The formExtractionParams.

getFormExtractionParamsOrBuilder()

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;

Returns
TypeDescription
FormExtractionParamsOrBuilder

getInputConfig()

public InputConfig getInputConfig()

Required. Information about the input file.

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

Returns
TypeDescription
InputConfig

The inputConfig.

getInputConfigOrBuilder()

public InputConfigOrBuilder getInputConfigOrBuilder()

Required. Information about the input file.

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

Returns
TypeDescription
InputConfigOrBuilder

getOcrParams()

public OcrParams getOcrParams()

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

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

Returns
TypeDescription
OcrParams

The ocrParams.

getOcrParamsOrBuilder()

public OcrParamsOrBuilder getOcrParamsOrBuilder()

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

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

Returns
TypeDescription
OcrParamsOrBuilder

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];

Returns
TypeDescription
OutputConfig

The outputConfig.

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];

Returns
TypeDescription
OutputConfigOrBuilder

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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<ProcessDocumentRequest> getParserForType()
Returns
TypeDescription
Parser<ProcessDocumentRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTableExtractionParams()

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;

Returns
TypeDescription
TableExtractionParams

The tableExtractionParams.

getTableExtractionParamsOrBuilder()

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;

Returns
TypeDescription
TableExtractionParamsOrBuilder

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;

Returns
TypeDescription
boolean

Whether the automlParams field is set.

hasEntityExtractionParams()

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;

Returns
TypeDescription
boolean

Whether the entityExtractionParams field is set.

hasFormExtractionParams()

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;

Returns
TypeDescription
boolean

Whether the formExtractionParams field is set.

hasInputConfig()

public boolean hasInputConfig()

Required. Information about the input file.

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

Returns
TypeDescription
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;

Returns
TypeDescription
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];

Returns
TypeDescription
boolean

Whether the outputConfig field is set.

hasTableExtractionParams()

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;

Returns
TypeDescription
boolean

Whether the tableExtractionParams field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ProcessDocumentRequest.Builder newBuilderForType()
Returns
TypeDescription
ProcessDocumentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProcessDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ProcessDocumentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ProcessDocumentRequest.Builder toBuilder()
Returns
TypeDescription
ProcessDocumentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException