Class ProcessDocumentRequest.Builder (2.53.0)

public static final class ProcessDocumentRequest.Builder extends GeneratedMessageV3.Builder<ProcessDocumentRequest.Builder> implements ProcessDocumentRequestOrBuilder

Request to process one document.

Protobuf type google.cloud.documentai.v1beta1.ProcessDocumentRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ProcessDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ProcessDocumentRequest.Builder
Overrides

build()

public ProcessDocumentRequest build()
Returns
Type Description
ProcessDocumentRequest

buildPartial()

public ProcessDocumentRequest buildPartial()
Returns
Type Description
ProcessDocumentRequest

clear()

public ProcessDocumentRequest.Builder clear()
Returns
Type Description
ProcessDocumentRequest.Builder
Overrides

clearDocumentType()

public ProcessDocumentRequest.Builder clearDocumentType()

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
ProcessDocumentRequest.Builder

This builder for chaining.

clearEntityExtractionParams()

public ProcessDocumentRequest.Builder clearEntityExtractionParams()

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

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

Returns
Type Description
ProcessDocumentRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ProcessDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ProcessDocumentRequest.Builder
Overrides

clearFormExtractionParams()

public ProcessDocumentRequest.Builder clearFormExtractionParams()

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

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

Returns
Type Description
ProcessDocumentRequest.Builder

clearInputConfig()

public ProcessDocumentRequest.Builder clearInputConfig()

Required. Information about the input file.

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

Returns
Type Description
ProcessDocumentRequest.Builder

clearOcrParams()

public ProcessDocumentRequest.Builder clearOcrParams()

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

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

Returns
Type Description
ProcessDocumentRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ProcessDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ProcessDocumentRequest.Builder
Overrides

clearOutputConfig()

public ProcessDocumentRequest.Builder clearOutputConfig()

Required. The desired output location.

.google.cloud.documentai.v1beta1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProcessDocumentRequest.Builder

clearTableExtractionParams()

public ProcessDocumentRequest.Builder clearTableExtractionParams()

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

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

Returns
Type Description
ProcessDocumentRequest.Builder

clone()

public ProcessDocumentRequest.Builder clone()
Returns
Type Description
ProcessDocumentRequest.Builder
Overrides

getDefaultInstanceForType()

public ProcessDocumentRequest getDefaultInstanceForType()
Returns
Type Description
ProcessDocumentRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.v1beta1.EntityExtractionParams entity_extraction_params = 6;

Returns
Type Description
EntityExtractionParams

The entityExtractionParams.

getEntityExtractionParamsBuilder()

public EntityExtractionParams.Builder getEntityExtractionParamsBuilder()

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

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

Returns
Type Description
EntityExtractionParams.Builder

getEntityExtractionParamsOrBuilder()

public EntityExtractionParamsOrBuilder getEntityExtractionParamsOrBuilder()

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

.google.cloud.documentai.v1beta1.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.v1beta1.FormExtractionParams form_extraction_params = 5;

Returns
Type Description
FormExtractionParams

The formExtractionParams.

getFormExtractionParamsBuilder()

public FormExtractionParams.Builder getFormExtractionParamsBuilder()

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

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

Returns
Type Description
FormExtractionParams.Builder

getFormExtractionParamsOrBuilder()

public FormExtractionParamsOrBuilder getFormExtractionParamsOrBuilder()

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

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

Returns
Type Description
FormExtractionParamsOrBuilder

getInputConfig()

public InputConfig getInputConfig()

Required. Information about the input file.

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

Returns
Type Description
InputConfig

The inputConfig.

getInputConfigBuilder()

public InputConfig.Builder getInputConfigBuilder()

Required. Information about the input file.

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

Returns
Type Description
InputConfig.Builder

getInputConfigOrBuilder()

public InputConfigOrBuilder getInputConfigOrBuilder()

Required. Information about the input file.

.google.cloud.documentai.v1beta1.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.v1beta1.OcrParams ocr_params = 7;

Returns
Type Description
OcrParams

The ocrParams.

getOcrParamsBuilder()

public OcrParams.Builder getOcrParamsBuilder()

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

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

Returns
Type Description
OcrParams.Builder

getOcrParamsOrBuilder()

public OcrParamsOrBuilder getOcrParamsOrBuilder()

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

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

Returns
Type Description
OcrParamsOrBuilder

getOutputConfig()

public OutputConfig getOutputConfig()

Required. The desired output location.

.google.cloud.documentai.v1beta1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputConfig

The outputConfig.

getOutputConfigBuilder()

public OutputConfig.Builder getOutputConfigBuilder()

Required. The desired output location.

.google.cloud.documentai.v1beta1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputConfig.Builder

getOutputConfigOrBuilder()

public OutputConfigOrBuilder getOutputConfigOrBuilder()

Required. The desired output location.

.google.cloud.documentai.v1beta1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputConfigOrBuilder

getTableExtractionParams()

public TableExtractionParams getTableExtractionParams()

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

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

Returns
Type Description
TableExtractionParams

The tableExtractionParams.

getTableExtractionParamsBuilder()

public TableExtractionParams.Builder getTableExtractionParamsBuilder()

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

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

Returns
Type Description
TableExtractionParams.Builder

getTableExtractionParamsOrBuilder()

public TableExtractionParamsOrBuilder getTableExtractionParamsOrBuilder()

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

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

Returns
Type Description
TableExtractionParamsOrBuilder

hasEntityExtractionParams()

public boolean hasEntityExtractionParams()

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

.google.cloud.documentai.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.OcrParams ocr_params = 7;

Returns
Type Description
boolean

Whether the ocrParams field is set.

hasOutputConfig()

public boolean hasOutputConfig()

Required. The desired output location.

.google.cloud.documentai.v1beta1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

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.v1beta1.TableExtractionParams table_extraction_params = 4;

Returns
Type Description
boolean

Whether the tableExtractionParams field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEntityExtractionParams(EntityExtractionParams value)

public ProcessDocumentRequest.Builder mergeEntityExtractionParams(EntityExtractionParams value)

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

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

Parameter
Name Description
value EntityExtractionParams
Returns
Type Description
ProcessDocumentRequest.Builder

mergeFormExtractionParams(FormExtractionParams value)

public ProcessDocumentRequest.Builder mergeFormExtractionParams(FormExtractionParams value)

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

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

Parameter
Name Description
value FormExtractionParams
Returns
Type Description
ProcessDocumentRequest.Builder

mergeFrom(ProcessDocumentRequest other)

public ProcessDocumentRequest.Builder mergeFrom(ProcessDocumentRequest other)
Parameter
Name Description
other ProcessDocumentRequest
Returns
Type Description
ProcessDocumentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ProcessDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessDocumentRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ProcessDocumentRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ProcessDocumentRequest.Builder
Overrides

mergeInputConfig(InputConfig value)

public ProcessDocumentRequest.Builder mergeInputConfig(InputConfig value)

Required. Information about the input file.

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

Parameter
Name Description
value InputConfig
Returns
Type Description
ProcessDocumentRequest.Builder

mergeOcrParams(OcrParams value)

public ProcessDocumentRequest.Builder mergeOcrParams(OcrParams value)

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

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

Parameter
Name Description
value OcrParams
Returns
Type Description
ProcessDocumentRequest.Builder

mergeOutputConfig(OutputConfig value)

public ProcessDocumentRequest.Builder mergeOutputConfig(OutputConfig value)

Required. The desired output location.

.google.cloud.documentai.v1beta1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value OutputConfig
Returns
Type Description
ProcessDocumentRequest.Builder

mergeTableExtractionParams(TableExtractionParams value)

public ProcessDocumentRequest.Builder mergeTableExtractionParams(TableExtractionParams value)

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

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

Parameter
Name Description
value TableExtractionParams
Returns
Type Description
ProcessDocumentRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ProcessDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ProcessDocumentRequest.Builder
Overrides

setDocumentType(String value)

public ProcessDocumentRequest.Builder setDocumentType(String value)

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;

Parameter
Name Description
value String

The documentType to set.

Returns
Type Description
ProcessDocumentRequest.Builder

This builder for chaining.

setDocumentTypeBytes(ByteString value)

public ProcessDocumentRequest.Builder setDocumentTypeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for documentType to set.

Returns
Type Description
ProcessDocumentRequest.Builder

This builder for chaining.

setEntityExtractionParams(EntityExtractionParams value)

public ProcessDocumentRequest.Builder setEntityExtractionParams(EntityExtractionParams value)

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

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

Parameter
Name Description
value EntityExtractionParams
Returns
Type Description
ProcessDocumentRequest.Builder

setEntityExtractionParams(EntityExtractionParams.Builder builderForValue)

public ProcessDocumentRequest.Builder setEntityExtractionParams(EntityExtractionParams.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue EntityExtractionParams.Builder
Returns
Type Description
ProcessDocumentRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ProcessDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ProcessDocumentRequest.Builder
Overrides

setFormExtractionParams(FormExtractionParams value)

public ProcessDocumentRequest.Builder setFormExtractionParams(FormExtractionParams value)

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

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

Parameter
Name Description
value FormExtractionParams
Returns
Type Description
ProcessDocumentRequest.Builder

setFormExtractionParams(FormExtractionParams.Builder builderForValue)

public ProcessDocumentRequest.Builder setFormExtractionParams(FormExtractionParams.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue FormExtractionParams.Builder
Returns
Type Description
ProcessDocumentRequest.Builder

setInputConfig(InputConfig value)

public ProcessDocumentRequest.Builder setInputConfig(InputConfig value)

Required. Information about the input file.

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

Parameter
Name Description
value InputConfig
Returns
Type Description
ProcessDocumentRequest.Builder

setInputConfig(InputConfig.Builder builderForValue)

public ProcessDocumentRequest.Builder setInputConfig(InputConfig.Builder builderForValue)

Required. Information about the input file.

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

Parameter
Name Description
builderForValue InputConfig.Builder
Returns
Type Description
ProcessDocumentRequest.Builder

setOcrParams(OcrParams value)

public ProcessDocumentRequest.Builder setOcrParams(OcrParams value)

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

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

Parameter
Name Description
value OcrParams
Returns
Type Description
ProcessDocumentRequest.Builder

setOcrParams(OcrParams.Builder builderForValue)

public ProcessDocumentRequest.Builder setOcrParams(OcrParams.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue OcrParams.Builder
Returns
Type Description
ProcessDocumentRequest.Builder

setOutputConfig(OutputConfig value)

public ProcessDocumentRequest.Builder setOutputConfig(OutputConfig value)

Required. The desired output location.

.google.cloud.documentai.v1beta1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value OutputConfig
Returns
Type Description
ProcessDocumentRequest.Builder

setOutputConfig(OutputConfig.Builder builderForValue)

public ProcessDocumentRequest.Builder setOutputConfig(OutputConfig.Builder builderForValue)

Required. The desired output location.

.google.cloud.documentai.v1beta1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue OutputConfig.Builder
Returns
Type Description
ProcessDocumentRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ProcessDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ProcessDocumentRequest.Builder
Overrides

setTableExtractionParams(TableExtractionParams value)

public ProcessDocumentRequest.Builder setTableExtractionParams(TableExtractionParams value)

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

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

Parameter
Name Description
value TableExtractionParams
Returns
Type Description
ProcessDocumentRequest.Builder

setTableExtractionParams(TableExtractionParams.Builder builderForValue)

public ProcessDocumentRequest.Builder setTableExtractionParams(TableExtractionParams.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue TableExtractionParams.Builder
Returns
Type Description
ProcessDocumentRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ProcessDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ProcessDocumentRequest.Builder
Overrides