Class ProcessOptions.Builder (2.46.0)

Version 2.46.0

• 2.59.0 (latest)
• 2.58.0
• 2.57.0
• 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 static final class ProcessOptions.Builder extends GeneratedMessageV3.Builder<ProcessOptions.Builder> implements ProcessOptionsOrBuilder

Options for Process API

Protobuf type google.cloud.documentai.v1.ProcessOptions

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ProcessOptions.Builder

Implements

ProcessOptionsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ProcessOptions.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ProcessOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ProcessOptions getDefaultInstanceForType()

Returns
Type	Description
ProcessOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ProcessOptions.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ProcessOptions.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)