Package com.google.cloud.documentai.v1

Class ProcessOptions.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ProcessOptions.Builder>
com.google.cloud.documentai.v1.ProcessOptions.Builder
All Implemented Interfaces:
ProcessOptionsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ProcessOptions
public static final class ProcessOptions.Builder extends com.google.protobuf.GeneratedMessage.Builder<ProcessOptions.Builder> implements ProcessOptionsOrBuilder
 Options for Process API
Protobuf type google.cloud.documentai.v1.ProcessOptions

  • 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.Builder<ProcessOptions.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ProcessOptions.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ProcessOptions.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProcessOptions.Builder>

    • mergeFrom

      public ProcessOptions.Builder mergeFrom(ProcessOptions other)

    • isInitialized

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

    • mergeFrom

      public ProcessOptions.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProcessOptions.Builder>
      Throws:
      IOException

    • getPageRangeCase

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

    • clearPageRange

      public ProcessOptions.Builder clearPageRange()

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

    • setIndividualPageSelector

      public ProcessOptions.Builder setIndividualPageSelector(ProcessOptions.IndividualPageSelector value)
       Which pages to process (1-indexed).
      .google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;

    • setIndividualPageSelector

      public ProcessOptions.Builder setIndividualPageSelector(ProcessOptions.IndividualPageSelector.Builder builderForValue)
       Which pages to process (1-indexed).
      .google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;

    • mergeIndividualPageSelector

      public ProcessOptions.Builder mergeIndividualPageSelector(ProcessOptions.IndividualPageSelector value)
       Which pages to process (1-indexed).
      .google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;

    • clearIndividualPageSelector

      public ProcessOptions.Builder clearIndividualPageSelector()
       Which pages to process (1-indexed).
      .google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;

    • getIndividualPageSelectorBuilder

      public ProcessOptions.IndividualPageSelector.Builder getIndividualPageSelectorBuilder()
       Which pages to process (1-indexed).
      .google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector individual_page_selector = 5;

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

    • setFromStart

      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;
      Parameters:
      value - The fromStart to set.
      Returns:
      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:
      This builder for chaining.

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

    • setFromEnd

      public ProcessOptions.Builder setFromEnd(int value)
       Only process certain pages from the end, same as above.
      int32 from_end = 7;
      Parameters:
      value - The fromEnd to set.
      Returns:
      This builder for chaining.

    • clearFromEnd

      public ProcessOptions.Builder clearFromEnd()
       Only process certain pages from the end, same as above.
      int32 from_end = 7;
      Returns:
      This builder for chaining.

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

    • setOcrConfig

      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;

    • setOcrConfig

      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;

    • mergeOcrConfig

      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;

    • 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;

    • 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;

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

    • setLayoutConfig

      public ProcessOptions.Builder setLayoutConfig(ProcessOptions.LayoutConfig value)
       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];

    • setLayoutConfig

      public ProcessOptions.Builder setLayoutConfig(ProcessOptions.LayoutConfig.Builder builderForValue)
       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];

    • mergeLayoutConfig

      public ProcessOptions.Builder mergeLayoutConfig(ProcessOptions.LayoutConfig value)
       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];

    • clearLayoutConfig

      public ProcessOptions.Builder clearLayoutConfig()
       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];

    • getLayoutConfigBuilder

      public ProcessOptions.LayoutConfig.Builder getLayoutConfigBuilder()
       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];

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

    • setSchemaOverride

      public ProcessOptions.Builder setSchemaOverride(DocumentSchema value)
       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];

    • setSchemaOverride

      public ProcessOptions.Builder setSchemaOverride(DocumentSchema.Builder builderForValue)
       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];

    • mergeSchemaOverride

      public ProcessOptions.Builder mergeSchemaOverride(DocumentSchema value)
       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];

    • clearSchemaOverride

      public ProcessOptions.Builder clearSchemaOverride()
       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];

    • getSchemaOverrideBuilder

      public DocumentSchema.Builder getSchemaOverrideBuilder()
       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];

    • 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