Class ProcessOptions.Builder (2.47.0)

public static final class ProcessOptions.Builder extends GeneratedMessageV3.Builder<ProcessOptions.Builder> implements ProcessOptionsOrBuilder

Options for Process API

Protobuf type google.cloud.documentai.v1.ProcessOptions

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ProcessOptions build()
Returns
Type Description
ProcessOptions

buildPartial()

public ProcessOptions buildPartial()
Returns
Type Description
ProcessOptions

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFromEnd()

public ProcessOptions.Builder clearFromEnd()

Only process certain pages from the end, same as above.

int32 from_end = 7;

Returns
Type Description
ProcessOptions.Builder

This builder for chaining.

clearFromStart()

public ProcessOptions.Builder clearFromStart()

Only process certain pages from the start. Process all if the document has fewer pages.

int32 from_start = 6;

Returns
Type Description
ProcessOptions.Builder

This builder for chaining.

clearIndividualPageSelector()

public ProcessOptions.Builder clearIndividualPageSelector()

Which pages to process (1-indexed).

.google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;

Returns
Type Description
ProcessOptions.Builder

clearOcrConfig()

public ProcessOptions.Builder clearOcrConfig()

Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR. Returns error if set on other processor types.

.google.cloud.documentai.v1.OcrConfig ocr_config = 1;

Returns
Type Description
ProcessOptions.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageRange()

public ProcessOptions.Builder clearPageRange()
Returns
Type Description
ProcessOptions.Builder

clearSchemaOverride()

public ProcessOptions.Builder clearSchemaOverride()

Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override.

.google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProcessOptions.Builder

clone()

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

getDefaultInstanceForType()

public ProcessOptions getDefaultInstanceForType()
Returns
Type Description
ProcessOptions

getDescriptorForType()

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

getFromEnd()

public int getFromEnd()

Only process certain pages from the end, same as above.

int32 from_end = 7;

Returns
Type Description
int

The fromEnd.

getFromStart()

public int getFromStart()

Only process certain pages from the start. Process all if the document has fewer pages.

int32 from_start = 6;

Returns
Type Description
int

The fromStart.

getIndividualPageSelector()

public ProcessOptions.IndividualPageSelector getIndividualPageSelector()

Which pages to process (1-indexed).

.google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;

Returns
Type Description
ProcessOptions.IndividualPageSelector

The individualPageSelector.

getIndividualPageSelectorBuilder()

public ProcessOptions.IndividualPageSelector.Builder getIndividualPageSelectorBuilder()

Which pages to process (1-indexed).

.google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;

Returns
Type Description
ProcessOptions.IndividualPageSelector.Builder

getIndividualPageSelectorOrBuilder()

public ProcessOptions.IndividualPageSelectorOrBuilder getIndividualPageSelectorOrBuilder()

Which pages to process (1-indexed).

.google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;

Returns
Type Description
ProcessOptions.IndividualPageSelectorOrBuilder

getOcrConfig()

public OcrConfig getOcrConfig()

Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR. Returns error if set on other processor types.

.google.cloud.documentai.v1.OcrConfig ocr_config = 1;

Returns
Type Description
OcrConfig

The ocrConfig.

getOcrConfigBuilder()

public OcrConfig.Builder getOcrConfigBuilder()

Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR. Returns error if set on other processor types.

.google.cloud.documentai.v1.OcrConfig ocr_config = 1;

Returns
Type Description
OcrConfig.Builder

getOcrConfigOrBuilder()

public OcrConfigOrBuilder getOcrConfigOrBuilder()

Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR. Returns error if set on other processor types.

.google.cloud.documentai.v1.OcrConfig ocr_config = 1;

Returns
Type Description
OcrConfigOrBuilder

getPageRangeCase()

public ProcessOptions.PageRangeCase getPageRangeCase()
Returns
Type Description
ProcessOptions.PageRangeCase

getSchemaOverride()

public DocumentSchema getSchemaOverride()

Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override.

.google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DocumentSchema

The schemaOverride.

getSchemaOverrideBuilder()

public DocumentSchema.Builder getSchemaOverrideBuilder()

Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override.

.google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DocumentSchema.Builder

getSchemaOverrideOrBuilder()

public DocumentSchemaOrBuilder getSchemaOverrideOrBuilder()

Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override.

.google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DocumentSchemaOrBuilder

hasFromEnd()

public boolean hasFromEnd()

Only process certain pages from the end, same as above.

int32 from_end = 7;

Returns
Type Description
boolean

Whether the fromEnd field is set.

hasFromStart()

public boolean hasFromStart()

Only process certain pages from the start. Process all if the document has fewer pages.

int32 from_start = 6;

Returns
Type Description
boolean

Whether the fromStart field is set.

hasIndividualPageSelector()

public boolean hasIndividualPageSelector()

Which pages to process (1-indexed).

.google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;

Returns
Type Description
boolean

Whether the individualPageSelector field is set.

hasOcrConfig()

public boolean hasOcrConfig()

Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR. Returns error if set on other processor types.

.google.cloud.documentai.v1.OcrConfig ocr_config = 1;

Returns
Type Description
boolean

Whether the ocrConfig field is set.

hasSchemaOverride()

public boolean hasSchemaOverride()

Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override.

.google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the schemaOverride field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ProcessOptions other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeIndividualPageSelector(ProcessOptions.IndividualPageSelector value)

public ProcessOptions.Builder mergeIndividualPageSelector(ProcessOptions.IndividualPageSelector value)

Which pages to process (1-indexed).

.google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;

Parameter
Name Description
value ProcessOptions.IndividualPageSelector
Returns
Type Description
ProcessOptions.Builder

mergeOcrConfig(OcrConfig value)

public ProcessOptions.Builder mergeOcrConfig(OcrConfig value)

Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR. Returns error if set on other processor types.

.google.cloud.documentai.v1.OcrConfig ocr_config = 1;

Parameter
Name Description
value OcrConfig
Returns
Type Description
ProcessOptions.Builder

mergeSchemaOverride(DocumentSchema value)

public ProcessOptions.Builder mergeSchemaOverride(DocumentSchema value)

Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override.

.google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DocumentSchema
Returns
Type Description
ProcessOptions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFromEnd(int value)

public ProcessOptions.Builder setFromEnd(int value)

Only process certain pages from the end, same as above.

int32 from_end = 7;

Parameter
Name Description
value int

The fromEnd to set.

Returns
Type Description
ProcessOptions.Builder

This builder for chaining.

setFromStart(int value)

public ProcessOptions.Builder setFromStart(int value)

Only process certain pages from the start. Process all if the document has fewer pages.

int32 from_start = 6;

Parameter
Name Description
value int

The fromStart to set.

Returns
Type Description
ProcessOptions.Builder

This builder for chaining.

setIndividualPageSelector(ProcessOptions.IndividualPageSelector value)

public ProcessOptions.Builder setIndividualPageSelector(ProcessOptions.IndividualPageSelector value)

Which pages to process (1-indexed).

.google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;

Parameter
Name Description
value ProcessOptions.IndividualPageSelector
Returns
Type Description
ProcessOptions.Builder

setIndividualPageSelector(ProcessOptions.IndividualPageSelector.Builder builderForValue)

public ProcessOptions.Builder setIndividualPageSelector(ProcessOptions.IndividualPageSelector.Builder builderForValue)

Which pages to process (1-indexed).

.google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;

Parameter
Name Description
builderForValue ProcessOptions.IndividualPageSelector.Builder
Returns
Type Description
ProcessOptions.Builder

setOcrConfig(OcrConfig value)

public ProcessOptions.Builder setOcrConfig(OcrConfig value)

Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR. Returns error if set on other processor types.

.google.cloud.documentai.v1.OcrConfig ocr_config = 1;

Parameter
Name Description
value OcrConfig
Returns
Type Description
ProcessOptions.Builder

setOcrConfig(OcrConfig.Builder builderForValue)

public ProcessOptions.Builder setOcrConfig(OcrConfig.Builder builderForValue)

Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR. Returns error if set on other processor types.

.google.cloud.documentai.v1.OcrConfig ocr_config = 1;

Parameter
Name Description
builderForValue OcrConfig.Builder
Returns
Type Description
ProcessOptions.Builder

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

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

setSchemaOverride(DocumentSchema value)

public ProcessOptions.Builder setSchemaOverride(DocumentSchema value)

Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override.

.google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DocumentSchema
Returns
Type Description
ProcessOptions.Builder

setSchemaOverride(DocumentSchema.Builder builderForValue)

public ProcessOptions.Builder setSchemaOverride(DocumentSchema.Builder builderForValue)

Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override.

.google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DocumentSchema.Builder
Returns
Type Description
ProcessOptions.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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