Class ProcessDocumentRequest (2.50.0)

Version 2.50.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public final class ProcessDocumentRequest extends GeneratedMessageV3 implements ProcessDocumentRequestOrBuilder

Request to process one document.

Protobuf type google.cloud.documentai.v1beta2.ProcessDocumentRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ProcessDocumentRequest

Implements

ProcessDocumentRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AUTOML_PARAMS_FIELD_NUMBER

public static final int AUTOML_PARAMS_FIELD_NUMBER

Field Value
Type	Description
int

DOCUMENT_TYPE_FIELD_NUMBER

public static final int DOCUMENT_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

ENTITY_EXTRACTION_PARAMS_FIELD_NUMBER

public static final int ENTITY_EXTRACTION_PARAMS_FIELD_NUMBER

Field Value
Type	Description
int

FORM_EXTRACTION_PARAMS_FIELD_NUMBER

public static final int FORM_EXTRACTION_PARAMS_FIELD_NUMBER

Field Value
Type	Description
int

INPUT_CONFIG_FIELD_NUMBER

public static final int INPUT_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

OCR_PARAMS_FIELD_NUMBER

public static final int OCR_PARAMS_FIELD_NUMBER

Field Value
Type	Description
int

OUTPUT_CONFIG_FIELD_NUMBER

public static final int OUTPUT_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

Field Value
Type	Description
int

TABLE_EXTRACTION_PARAMS_FIELD_NUMBER

public static final int TABLE_EXTRACTION_PARAMS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static ProcessDocumentRequest getDefaultInstance()

Returns
Type	Description
ProcessDocumentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static ProcessDocumentRequest.Builder newBuilder()

Returns
Type	Description
ProcessDocumentRequest.Builder

newBuilder(ProcessDocumentRequest prototype)

public static ProcessDocumentRequest.Builder newBuilder(ProcessDocumentRequest prototype)

Parameter
Name	Description
prototype	ProcessDocumentRequest

Returns
Type	Description
ProcessDocumentRequest.Builder

parseDelimitedFrom(InputStream input)

public static ProcessDocumentRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ProcessDocumentRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ProcessDocumentRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static ProcessDocumentRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
ProcessDocumentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProcessDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ProcessDocumentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProcessDocumentRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
ProcessDocumentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProcessDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ProcessDocumentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProcessDocumentRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
ProcessDocumentRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ProcessDocumentRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static ProcessDocumentRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ProcessDocumentRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ProcessDocumentRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static ProcessDocumentRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
ProcessDocumentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProcessDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ProcessDocumentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ProcessDocumentRequest> parser()

Returns
Type	Description
Parser<ProcessDocumentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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
Type	Description
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
Type	Description
AutoMlParamsOrBuilder

getDefaultInstanceForType()

public ProcessDocumentRequest getDefaultInstanceForType()

Returns
Type	Description
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
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;

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
OcrParamsOrBuilder

getOutputConfig()

public OutputConfig getOutputConfig()

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

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

Returns
Type	Description
OutputConfig	The outputConfig.

getOutputConfigOrBuilder()

public OutputConfigOrBuilder getOutputConfigOrBuilder()

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

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

Returns
Type	Description
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
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;

Returns
Type	Description
ByteString	The bytes for parent.

getParserForType()

public Parser<ProcessDocumentRequest> getParserForType()

Returns
Type	Description
Parser<ProcessDocumentRequest>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
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;

Returns
Type	Description
boolean	Whether the ocrParams field is set.

hasOutputConfig()

public boolean hasOutputConfig()

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

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

Returns
Type	Description
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
Type	Description
boolean	Whether the tableExtractionParams field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public ProcessDocumentRequest.Builder newBuilderForType()

Returns
Type	Description
ProcessDocumentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProcessDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
ProcessDocumentRequest.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ProcessDocumentRequest.Builder toBuilder()

Returns
Type	Description
ProcessDocumentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException