Class ProcessOptions (2.80.0)
Version 2.80.0keyboard_arrow_down
public final class ProcessOptions extends GeneratedMessageV3 implements ProcessOptionsOrBuilder
Options for Process API
Protobuf type google.cloud.documentai.v1beta3.ProcessOptions
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FROM_END_FIELD_NUMBER
public static final int FROM_END_FIELD_NUMBER
Field Value
Type Description
int
FROM_START_FIELD_NUMBER
public static final int FROM_START_FIELD_NUMBER
Field Value
Type Description
int
INDIVIDUAL_PAGE_SELECTOR_FIELD_NUMBER
public static final int INDIVIDUAL_PAGE_SELECTOR_FIELD_NUMBER
Field Value
Type Description
int
LAYOUT_CONFIG_FIELD_NUMBER
public static final int LAYOUT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int
OCR_CONFIG_FIELD_NUMBER
public static final int OCR_CONFIG_FIELD_NUMBER
Field Value
Type Description
int
SCHEMA_OVERRIDE_FIELD_NUMBER
public static final int SCHEMA_OVERRIDE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static ProcessOptions getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ProcessOptions . Builder newBuilder ()
newBuilder(ProcessOptions prototype)
public static ProcessOptions . Builder newBuilder ( ProcessOptions prototype )
public static ProcessOptions parseDelimitedFrom ( InputStream input )
public static ProcessOptions parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ProcessOptions parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ProcessOptions parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ProcessOptions parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ProcessOptions parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ProcessOptions parseFrom ( CodedInputStream input )
public static ProcessOptions parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ProcessOptions parseFrom ( InputStream input )
public static ProcessOptions parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ProcessOptions parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ProcessOptions parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ProcessOptions> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public ProcessOptions getDefaultInstanceForType ()
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.v1beta3.ProcessOptions.IndividualPageSelector individual_page_selector = 5;
getIndividualPageSelectorOrBuilder()
public ProcessOptions . IndividualPageSelectorOrBuilder getIndividualPageSelectorOrBuilder ()
Which pages to process (1-indexed).
.google.cloud.documentai.v1beta3.ProcessOptions.IndividualPageSelector individual_page_selector = 5;
getLayoutConfig()
public ProcessOptions . LayoutConfig getLayoutConfig ()
Optional. Only applicable to LAYOUT_PARSER_PROCESSOR.
Returns error if set on other processor types.
.google.cloud.documentai.v1beta3.ProcessOptions.LayoutConfig layout_config = 9 [(.google.api.field_behavior) = OPTIONAL];
getLayoutConfigOrBuilder()
public ProcessOptions . LayoutConfigOrBuilder getLayoutConfigOrBuilder ()
Optional. Only applicable to LAYOUT_PARSER_PROCESSOR.
Returns error if set on other processor types.
.google.cloud.documentai.v1beta3.ProcessOptions.LayoutConfig layout_config = 9 [(.google.api.field_behavior) = OPTIONAL];
getOcrConfig()
public OcrConfig getOcrConfig ()
Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR.
Returns error if set on other processor types.
.google.cloud.documentai.v1beta3.OcrConfig ocr_config = 1;
Returns
Type Description
OcrConfig The ocrConfig.
getOcrConfigOrBuilder()
public OcrConfigOrBuilder getOcrConfigOrBuilder ()
Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR.
Returns error if set on other processor types.
.google.cloud.documentai.v1beta3.OcrConfig ocr_config = 1;
public ProcessOptions . PageRangeCase getPageRangeCase ()
getParserForType()
public Parser<ProcessOptions> getParserForType ()
Overrides
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.v1beta3.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];
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.v1beta3.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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.v1beta3.ProcessOptions.IndividualPageSelector individual_page_selector = 5;
Returns
Type Description
boolean Whether the individualPageSelector field is set.
hasLayoutConfig()
public boolean hasLayoutConfig ()
Optional. Only applicable to LAYOUT_PARSER_PROCESSOR.
Returns error if set on other processor types.
.google.cloud.documentai.v1beta3.ProcessOptions.LayoutConfig layout_config = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the layoutConfig 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.v1beta3.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.v1beta3.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the schemaOverride field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ProcessOptions . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ProcessOptions . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public ProcessOptions . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
