Class ProcessDocumentRequest.Builder

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ProcessDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ProcessDocumentRequest.Builder
Overrides

build()

public ProcessDocumentRequest build()
Returns
TypeDescription
ProcessDocumentRequest

buildPartial()

public ProcessDocumentRequest buildPartial()
Returns
TypeDescription
ProcessDocumentRequest

clear()

public ProcessDocumentRequest.Builder clear()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProcessDocumentRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ProcessDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ProcessDocumentRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ProcessDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProcessDocumentRequest.Builder

clone()

public ProcessDocumentRequest.Builder clone()
Returns
TypeDescription
ProcessDocumentRequest.Builder
Overrides

getDefaultInstanceForType()

public ProcessDocumentRequest getDefaultInstanceForType()
Returns
TypeDescription
ProcessDocumentRequest

getDescriptor()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
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.v1beta1.EntityExtractionParams entity_extraction_params = 6;

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

getOutputConfig()

public OutputConfig getOutputConfig()

Required. The desired output location.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
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.v1beta1.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.v1beta1.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.v1beta1.OcrParams ocr_params = 7;

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

Returns
TypeDescription
boolean

Whether the tableExtractionParams field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueEntityExtractionParams
Returns
TypeDescription
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
NameDescription
valueFormExtractionParams
Returns
TypeDescription
ProcessDocumentRequest.Builder

mergeFrom(ProcessDocumentRequest other)

public ProcessDocumentRequest.Builder mergeFrom(ProcessDocumentRequest other)
Parameter
NameDescription
otherProcessDocumentRequest
Returns
TypeDescription
ProcessDocumentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ProcessDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessDocumentRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ProcessDocumentRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueInputConfig
Returns
TypeDescription
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
NameDescription
valueOcrParams
Returns
TypeDescription
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
NameDescription
valueOutputConfig
Returns
TypeDescription
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
NameDescription
valueTableExtractionParams
Returns
TypeDescription
ProcessDocumentRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ProcessDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The documentType to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for documentType to set.

Returns
TypeDescription
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
NameDescription
valueEntityExtractionParams
Returns
TypeDescription
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
NameDescription
builderForValueEntityExtractionParams.Builder
Returns
TypeDescription
ProcessDocumentRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ProcessDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueFormExtractionParams
Returns
TypeDescription
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
NameDescription
builderForValueFormExtractionParams.Builder
Returns
TypeDescription
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
NameDescription
valueInputConfig
Returns
TypeDescription
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
NameDescription
builderForValueInputConfig.Builder
Returns
TypeDescription
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
NameDescription
valueOcrParams
Returns
TypeDescription
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
NameDescription
builderForValueOcrParams.Builder
Returns
TypeDescription
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
NameDescription
valueOutputConfig
Returns
TypeDescription
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
NameDescription
builderForValueOutputConfig.Builder
Returns
TypeDescription
ProcessDocumentRequest.Builder

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

public ProcessDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueTableExtractionParams
Returns
TypeDescription
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
NameDescription
builderForValueTableExtractionParams.Builder
Returns
TypeDescription
ProcessDocumentRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ProcessDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ProcessDocumentRequest.Builder
Overrides