Class ProcessOptions (2.52.0) 

public final class ProcessOptions extends GeneratedMessageV3 implements ProcessOptionsOrBuilder

Options for Process API

Protobuf type google.cloud.documentai.v1.ProcessOptions

Inheritance

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

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()
Returns
Type Description
ProcessOptions

getDescriptor()

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

newBuilder()

public static ProcessOptions.Builder newBuilder()
Returns
Type Description
ProcessOptions.Builder

newBuilder(ProcessOptions prototype)

public static ProcessOptions.Builder newBuilder(ProcessOptions prototype)
Parameter
Name Description
prototype ProcessOptions
Returns
Type Description
ProcessOptions.Builder

parseDelimitedFrom(InputStream input)

public static ProcessOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ProcessOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessOptions
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ProcessOptions parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ProcessOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProcessOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ProcessOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProcessOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ProcessOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ProcessOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ProcessOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessOptions
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ProcessOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ProcessOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessOptions
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ProcessOptions> parser()
Returns
Type Description
Parser<ProcessOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ProcessOptions getDefaultInstanceForType()
Returns
Type Description
ProcessOptions

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.

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

getLayoutConfig()

public ProcessOptions.LayoutConfig getLayoutConfig()

Optional. Only applicable to LAYOUT_PARSER_PROCESSOR. Returns error if set on other processor types.

.google.cloud.documentai.v1.ProcessOptions.LayoutConfig layout_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProcessOptions.LayoutConfig

The layoutConfig.

getLayoutConfigOrBuilder()

public ProcessOptions.LayoutConfigOrBuilder getLayoutConfigOrBuilder()

Optional. Only applicable to LAYOUT_PARSER_PROCESSOR. Returns error if set on other processor types.

.google.cloud.documentai.v1.ProcessOptions.LayoutConfig layout_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProcessOptions.LayoutConfigOrBuilder

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.

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

getParserForType()

public Parser<ProcessOptions> getParserForType()
Returns
Type Description
Parser<ProcessOptions>
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.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DocumentSchema

The schemaOverride.

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

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.v1.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.v1.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.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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProcessOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ProcessOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException