Package com.google.cloud.discoveryengine.v1beta

Class DocumentProcessingConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.DocumentProcessingConfig
All Implemented Interfaces:
DocumentProcessingConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DocumentProcessingConfig extends com.google.protobuf.GeneratedMessage implements DocumentProcessingConfigOrBuilder
 A singleton resource of
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. If it's empty
 when [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is created
 and [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is set to
 [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED],
 the default parser will default to digital parser.
Protobuf type google.cloud.discoveryengine.v1beta.DocumentProcessingConfig
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • CHUNKING_CONFIG_FIELD_NUMBER

      public static final int CHUNKING_CONFIG_FIELD_NUMBER
      See Also:

    • DEFAULT_PARSING_CONFIG_FIELD_NUMBER

      public static final int DEFAULT_PARSING_CONFIG_FIELD_NUMBER
      See Also:

    • PARSING_CONFIG_OVERRIDES_FIELD_NUMBER

      public static final int PARSING_CONFIG_OVERRIDES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       The full resource name of the Document Processing Config.
 Format:
 `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
      string name = 1;
      Specified by:
      getName in interface DocumentProcessingConfigOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The full resource name of the Document Processing Config.
 Format:
 `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
      string name = 1;
      Specified by:
      getNameBytes in interface DocumentProcessingConfigOrBuilder
      Returns:
      The bytes for name.

    • hasChunkingConfig

      public boolean hasChunkingConfig()
       Whether chunking mode is enabled.
      .google.cloud.discoveryengine.v1beta.DocumentProcessingConfig.ChunkingConfig chunking_config = 3;
      Specified by:
      hasChunkingConfig in interface DocumentProcessingConfigOrBuilder
      Returns:
      Whether the chunkingConfig field is set.

    • getChunkingConfig

      public DocumentProcessingConfig.ChunkingConfig getChunkingConfig()
       Whether chunking mode is enabled.
      .google.cloud.discoveryengine.v1beta.DocumentProcessingConfig.ChunkingConfig chunking_config = 3;
      Specified by:
      getChunkingConfig in interface DocumentProcessingConfigOrBuilder
      Returns:
      The chunkingConfig.

    • getChunkingConfigOrBuilder

      public DocumentProcessingConfig.ChunkingConfigOrBuilder getChunkingConfigOrBuilder()
       Whether chunking mode is enabled.
      .google.cloud.discoveryengine.v1beta.DocumentProcessingConfig.ChunkingConfig chunking_config = 3;
      Specified by:
      getChunkingConfigOrBuilder in interface DocumentProcessingConfigOrBuilder

    • hasDefaultParsingConfig

      public boolean hasDefaultParsingConfig()
       Configurations for default Document parser.
 If not specified, we will configure it as default DigitalParsingConfig, and
 the default parsing config will be applied to all file types for Document
 parsing.
      .google.cloud.discoveryengine.v1beta.DocumentProcessingConfig.ParsingConfig default_parsing_config = 4;
      Specified by:
      hasDefaultParsingConfig in interface DocumentProcessingConfigOrBuilder
      Returns:
      Whether the defaultParsingConfig field is set.

    • getDefaultParsingConfig

      public DocumentProcessingConfig.ParsingConfig getDefaultParsingConfig()
       Configurations for default Document parser.
 If not specified, we will configure it as default DigitalParsingConfig, and
 the default parsing config will be applied to all file types for Document
 parsing.
      .google.cloud.discoveryengine.v1beta.DocumentProcessingConfig.ParsingConfig default_parsing_config = 4;
      Specified by:
      getDefaultParsingConfig in interface DocumentProcessingConfigOrBuilder
      Returns:
      The defaultParsingConfig.

    • getDefaultParsingConfigOrBuilder

      public DocumentProcessingConfig.ParsingConfigOrBuilder getDefaultParsingConfigOrBuilder()
       Configurations for default Document parser.
 If not specified, we will configure it as default DigitalParsingConfig, and
 the default parsing config will be applied to all file types for Document
 parsing.
      .google.cloud.discoveryengine.v1beta.DocumentProcessingConfig.ParsingConfig default_parsing_config = 4;
      Specified by:
      getDefaultParsingConfigOrBuilder in interface DocumentProcessingConfigOrBuilder

    • getParsingConfigOverridesCount

      public int getParsingConfigOverridesCount()
      Description copied from interface: DocumentProcessingConfigOrBuilder
       Map from file type to override the default parsing configuration based on
 the file type. Supported keys:

 * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
 parsing or layout parsing is supported.
 * `html`: Override parsing config for HTML files, only digital parsing and
 layout parsing are supported.
 * `docx`: Override parsing config for DOCX files, only digital parsing and
 layout parsing are supported.
 * `pptx`: Override parsing config for PPTX files, only digital parsing and
 layout parsing are supported.
 * `xlsm`: Override parsing config for XLSM files, only digital parsing and
 layout parsing are supported.
 * `xlsx`: Override parsing config for XLSX files, only digital parsing and
 layout parsing are supported.
      map<string, .google.cloud.discoveryengine.v1beta.DocumentProcessingConfig.ParsingConfig> parsing_config_overrides = 5;
      Specified by:
      getParsingConfigOverridesCount in interface DocumentProcessingConfigOrBuilder

    • containsParsingConfigOverrides

      public boolean containsParsingConfigOverrides(String key)
       Map from file type to override the default parsing configuration based on
 the file type. Supported keys:

 * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
 parsing or layout parsing is supported.
 * `html`: Override parsing config for HTML files, only digital parsing and
 layout parsing are supported.
 * `docx`: Override parsing config for DOCX files, only digital parsing and
 layout parsing are supported.
 * `pptx`: Override parsing config for PPTX files, only digital parsing and
 layout parsing are supported.
 * `xlsm`: Override parsing config for XLSM files, only digital parsing and
 layout parsing are supported.
 * `xlsx`: Override parsing config for XLSX files, only digital parsing and
 layout parsing are supported.
      map<string, .google.cloud.discoveryengine.v1beta.DocumentProcessingConfig.ParsingConfig> parsing_config_overrides = 5;
      Specified by:
      containsParsingConfigOverrides in interface DocumentProcessingConfigOrBuilder

    • getParsingConfigOverrides

      @Deprecated public Map<String,DocumentProcessingConfig.ParsingConfig> getParsingConfigOverrides()
      Deprecated.
      Use getParsingConfigOverridesMap() instead.
      Specified by:
      getParsingConfigOverrides in interface DocumentProcessingConfigOrBuilder

    • getParsingConfigOverridesMap

      public Map<String,DocumentProcessingConfig.ParsingConfig> getParsingConfigOverridesMap()
       Map from file type to override the default parsing configuration based on
 the file type. Supported keys:

 * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
 parsing or layout parsing is supported.
 * `html`: Override parsing config for HTML files, only digital parsing and
 layout parsing are supported.
 * `docx`: Override parsing config for DOCX files, only digital parsing and
 layout parsing are supported.
 * `pptx`: Override parsing config for PPTX files, only digital parsing and
 layout parsing are supported.
 * `xlsm`: Override parsing config for XLSM files, only digital parsing and
 layout parsing are supported.
 * `xlsx`: Override parsing config for XLSX files, only digital parsing and
 layout parsing are supported.
      map<string, .google.cloud.discoveryengine.v1beta.DocumentProcessingConfig.ParsingConfig> parsing_config_overrides = 5;
      Specified by:
      getParsingConfigOverridesMap in interface DocumentProcessingConfigOrBuilder

    • getParsingConfigOverridesOrDefault

      public DocumentProcessingConfig.ParsingConfig getParsingConfigOverridesOrDefault(String key, DocumentProcessingConfig.ParsingConfig defaultValue)
       Map from file type to override the default parsing configuration based on
 the file type. Supported keys:

 * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
 parsing or layout parsing is supported.
 * `html`: Override parsing config for HTML files, only digital parsing and
 layout parsing are supported.
 * `docx`: Override parsing config for DOCX files, only digital parsing and
 layout parsing are supported.
 * `pptx`: Override parsing config for PPTX files, only digital parsing and
 layout parsing are supported.
 * `xlsm`: Override parsing config for XLSM files, only digital parsing and
 layout parsing are supported.
 * `xlsx`: Override parsing config for XLSX files, only digital parsing and
 layout parsing are supported.
      map<string, .google.cloud.discoveryengine.v1beta.DocumentProcessingConfig.ParsingConfig> parsing_config_overrides = 5;
      Specified by:
      getParsingConfigOverridesOrDefault in interface DocumentProcessingConfigOrBuilder

    • getParsingConfigOverridesOrThrow

      public DocumentProcessingConfig.ParsingConfig getParsingConfigOverridesOrThrow(String key)
       Map from file type to override the default parsing configuration based on
 the file type. Supported keys:

 * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
 parsing or layout parsing is supported.
 * `html`: Override parsing config for HTML files, only digital parsing and
 layout parsing are supported.
 * `docx`: Override parsing config for DOCX files, only digital parsing and
 layout parsing are supported.
 * `pptx`: Override parsing config for PPTX files, only digital parsing and
 layout parsing are supported.
 * `xlsm`: Override parsing config for XLSM files, only digital parsing and
 layout parsing are supported.
 * `xlsx`: Override parsing config for XLSX files, only digital parsing and
 layout parsing are supported.
      map<string, .google.cloud.discoveryengine.v1beta.DocumentProcessingConfig.ParsingConfig> parsing_config_overrides = 5;
      Specified by:
      getParsingConfigOverridesOrThrow in interface DocumentProcessingConfigOrBuilder

    • 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 DocumentProcessingConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DocumentProcessingConfig.Builder newBuilder()

    • newBuilder

      public static DocumentProcessingConfig.Builder newBuilder(DocumentProcessingConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DocumentProcessingConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DocumentProcessingConfig> 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 DocumentProcessingConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder