Package com.google.cloud.documentai.v1

Class ProcessOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.ProcessOptions
All Implemented Interfaces:
ProcessOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ProcessOptions extends com.google.protobuf.GeneratedMessage implements ProcessOptionsOrBuilder
 Options for Process API
Protobuf type google.cloud.documentai.v1.ProcessOptions
See Also:

  • Field Details

    • INDIVIDUAL_PAGE_SELECTOR_FIELD_NUMBER

      public static final int INDIVIDUAL_PAGE_SELECTOR_FIELD_NUMBER
      See Also:

    • FROM_START_FIELD_NUMBER

      public static final int FROM_START_FIELD_NUMBER
      See Also:

    • FROM_END_FIELD_NUMBER

      public static final int FROM_END_FIELD_NUMBER
      See Also:

    • OCR_CONFIG_FIELD_NUMBER

      public static final int OCR_CONFIG_FIELD_NUMBER
      See Also:

    • LAYOUT_CONFIG_FIELD_NUMBER

      public static final int LAYOUT_CONFIG_FIELD_NUMBER
      See Also:

    • SCHEMA_OVERRIDE_FIELD_NUMBER

      public static final int SCHEMA_OVERRIDE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPageRangeCase

      public ProcessOptions.PageRangeCase getPageRangeCase()
      Specified by:
      getPageRangeCase in interface ProcessOptionsOrBuilder

    • hasIndividualPageSelector

      public boolean hasIndividualPageSelector()
       Which pages to process (1-indexed).
      .google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;
      Specified by:
      hasIndividualPageSelector in interface ProcessOptionsOrBuilder
      Returns:
      Whether the individualPageSelector field is set.

    • getIndividualPageSelector

      public ProcessOptions.IndividualPageSelector getIndividualPageSelector()
       Which pages to process (1-indexed).
      .google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;
      Specified by:
      getIndividualPageSelector in interface ProcessOptionsOrBuilder
      Returns:
      The individualPageSelector.

    • getIndividualPageSelectorOrBuilder

      public ProcessOptions.IndividualPageSelectorOrBuilder getIndividualPageSelectorOrBuilder()
       Which pages to process (1-indexed).
      .google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;
      Specified by:
      getIndividualPageSelectorOrBuilder in interface ProcessOptionsOrBuilder

    • hasFromStart

      public boolean hasFromStart()
       Only process certain pages from the start. Process all if the document
 has fewer pages.
      int32 from_start = 6;
      Specified by:
      hasFromStart in interface ProcessOptionsOrBuilder
      Returns:
      Whether the fromStart field is set.

    • getFromStart

      public int getFromStart()
       Only process certain pages from the start. Process all if the document
 has fewer pages.
      int32 from_start = 6;
      Specified by:
      getFromStart in interface ProcessOptionsOrBuilder
      Returns:
      The fromStart.

    • hasFromEnd

      public boolean hasFromEnd()
       Only process certain pages from the end, same as above.
      int32 from_end = 7;
      Specified by:
      hasFromEnd in interface ProcessOptionsOrBuilder
      Returns:
      Whether the fromEnd field is set.

    • getFromEnd

      public int getFromEnd()
       Only process certain pages from the end, same as above.
      int32 from_end = 7;
      Specified by:
      getFromEnd in interface ProcessOptionsOrBuilder
      Returns:
      The fromEnd.

    • 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;
      Specified by:
      hasOcrConfig in interface ProcessOptionsOrBuilder
      Returns:
      Whether the ocrConfig field is set.

    • 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;
      Specified by:
      getOcrConfig in interface ProcessOptionsOrBuilder
      Returns:
      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;
      Specified by:
      getOcrConfigOrBuilder in interface ProcessOptionsOrBuilder

    • 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];
      Specified by:
      hasLayoutConfig in interface ProcessOptionsOrBuilder
      Returns:
      Whether the layoutConfig field is set.

    • 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];
      Specified by:
      getLayoutConfig in interface ProcessOptionsOrBuilder
      Returns:
      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];
      Specified by:
      getLayoutConfigOrBuilder in interface ProcessOptionsOrBuilder

    • hasSchemaOverride

      public boolean hasSchemaOverride()
       Optional. Override the schema of the
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will
 return an Invalid Argument error if this field is set when the underlying
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] doesn't
 support schema override.
      .google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSchemaOverride in interface ProcessOptionsOrBuilder
      Returns:
      Whether the schemaOverride field is set.

    • getSchemaOverride

      public DocumentSchema getSchemaOverride()
       Optional. Override the schema of the
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will
 return an Invalid Argument error if this field is set when the underlying
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] doesn't
 support schema override.
      .google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSchemaOverride in interface ProcessOptionsOrBuilder
      Returns:
      The schemaOverride.

    • getSchemaOverrideOrBuilder

      public DocumentSchemaOrBuilder getSchemaOverrideOrBuilder()
       Optional. Override the schema of the
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will
 return an Invalid Argument error if this field is set when the underlying
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] doesn't
 support schema override.
      .google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSchemaOverrideOrBuilder in interface ProcessOptionsOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ProcessOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProcessOptions parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProcessOptions parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProcessOptions parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProcessOptions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProcessOptions parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProcessOptions parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ProcessOptions parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ProcessOptions parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ProcessOptions parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ProcessOptions parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ProcessOptions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ProcessOptions.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ProcessOptions.Builder newBuilder()

    • newBuilder

      public static ProcessOptions.Builder newBuilder(ProcessOptions prototype)

    • toBuilder

      public ProcessOptions.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ProcessOptions.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ProcessOptions getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ProcessOptions> parser()

    • getParserForType

      public com.google.protobuf.Parser<ProcessOptions> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ProcessOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder