Class ProcessOptions (2.34.0)

public final class ProcessOptions extends GeneratedMessageV3 implements ProcessOptionsOrBuilder

Options for Process API

Protobuf type google.cloud.documentai.v1beta3.ProcessOptions

Static Fields

FROM_END_FIELD_NUMBER

public static final int FROM_END_FIELD_NUMBER
Field Value
TypeDescription
int

FROM_START_FIELD_NUMBER

public static final int FROM_START_FIELD_NUMBER
Field Value
TypeDescription
int

INDIVIDUAL_PAGE_SELECTOR_FIELD_NUMBER

public static final int INDIVIDUAL_PAGE_SELECTOR_FIELD_NUMBER
Field Value
TypeDescription
int

OCR_CONFIG_FIELD_NUMBER

public static final int OCR_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

SCHEMA_OVERRIDE_FIELD_NUMBER

public static final int SCHEMA_OVERRIDE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ProcessOptions getDefaultInstance()
Returns
TypeDescription
ProcessOptions

getDescriptor()

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

newBuilder()

public static ProcessOptions.Builder newBuilder()
Returns
TypeDescription
ProcessOptions.Builder

newBuilder(ProcessOptions prototype)

public static ProcessOptions.Builder newBuilder(ProcessOptions prototype)
Parameter
NameDescription
prototypeProcessOptions
Returns
TypeDescription
ProcessOptions.Builder

parseDelimitedFrom(InputStream input)

public static ProcessOptions parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProcessOptions
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessOptions
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ProcessOptions parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ProcessOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProcessOptions parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ProcessOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProcessOptions parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ProcessOptions
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ProcessOptions parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProcessOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessOptions
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ProcessOptions parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ProcessOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProcessOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ProcessOptions> parser()
Returns
TypeDescription
Parser<ProcessOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ProcessOptions getDefaultInstanceForType()
Returns
TypeDescription
ProcessOptions

getFromEnd()

public int getFromEnd()

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

int32 from_end = 7;

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

The fromStart.

getIndividualPageSelector()

public ProcessOptions.IndividualPageSelector getIndividualPageSelector()

Which pages to process (1-indexed).

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

Returns
TypeDescription
ProcessOptions.IndividualPageSelector

The individualPageSelector.

getIndividualPageSelectorOrBuilder()

public ProcessOptions.IndividualPageSelectorOrBuilder getIndividualPageSelectorOrBuilder()

Which pages to process (1-indexed).

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

Returns
TypeDescription
ProcessOptions.IndividualPageSelectorOrBuilder

getOcrConfig()

public OcrConfig getOcrConfig()

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

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

Returns
TypeDescription
OcrConfig

The ocrConfig.

getOcrConfigOrBuilder()

public OcrConfigOrBuilder getOcrConfigOrBuilder()

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

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

Returns
TypeDescription
OcrConfigOrBuilder

getPageRangeCase()

public ProcessOptions.PageRangeCase getPageRangeCase()
Returns
TypeDescription
ProcessOptions.PageRangeCase

getParserForType()

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

Returns
TypeDescription
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.v1beta3.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DocumentSchemaOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasFromEnd()

public boolean hasFromEnd()

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

int32 from_end = 7;

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

Whether the individualPageSelector field is set.

hasOcrConfig()

public boolean hasOcrConfig()

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

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

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

Whether the schemaOverride field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ProcessOptions.Builder newBuilderForType()
Returns
TypeDescription
ProcessOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProcessOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ProcessOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ProcessOptions.Builder toBuilder()
Returns
TypeDescription
ProcessOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException