Class DocumentProcessingConfig (0.37.0)

public final class DocumentProcessingConfig extends GeneratedMessageV3 implements DocumentProcessingConfigOrBuilder

A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.

Protobuf type google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig

Static Fields

CHUNKING_CONFIG_FIELD_NUMBER

public static final int CHUNKING_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

DEFAULT_PARSING_CONFIG_FIELD_NUMBER

public static final int DEFAULT_PARSING_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PARSING_CONFIG_OVERRIDES_FIELD_NUMBER

public static final int PARSING_CONFIG_OVERRIDES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DocumentProcessingConfig getDefaultInstance()
Returns
TypeDescription
DocumentProcessingConfig

getDescriptor()

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

newBuilder()

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

newBuilder(DocumentProcessingConfig prototype)

public static DocumentProcessingConfig.Builder newBuilder(DocumentProcessingConfig prototype)
Parameter
NameDescription
prototypeDocumentProcessingConfig
Returns
TypeDescription
DocumentProcessingConfig.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsParsingConfigOverrides(String key)

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 or layout parsing are supported.
  • docx: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.

map<string, .google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig> parsing_config_overrides = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getChunkingConfig()

public DocumentProcessingConfig.ChunkingConfig getChunkingConfig()

Whether chunking mode is enabled.

.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ChunkingConfig chunking_config = 3;

Returns
TypeDescription
DocumentProcessingConfig.ChunkingConfig

The chunkingConfig.

getChunkingConfigOrBuilder()

public DocumentProcessingConfig.ChunkingConfigOrBuilder getChunkingConfigOrBuilder()

Whether chunking mode is enabled.

.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ChunkingConfig chunking_config = 3;

Returns
TypeDescription
DocumentProcessingConfig.ChunkingConfigOrBuilder

getDefaultInstanceForType()

public DocumentProcessingConfig getDefaultInstanceForType()
Returns
TypeDescription
DocumentProcessingConfig

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.v1alpha.DocumentProcessingConfig.ParsingConfig default_parsing_config = 4;

Returns
TypeDescription
DocumentProcessingConfig.ParsingConfig

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.v1alpha.DocumentProcessingConfig.ParsingConfig default_parsing_config = 4;

Returns
TypeDescription
DocumentProcessingConfig.ParsingConfigOrBuilder

getName()

public String getName()

The full resource name of the Document Processing Config. Format: projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The full resource name of the Document Processing Config. Format: projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<DocumentProcessingConfig> getParserForType()
Returns
TypeDescription
Parser<DocumentProcessingConfig>
Overrides

getParsingConfigOverrides() (deprecated)

public Map<String,DocumentProcessingConfig.ParsingConfig> getParsingConfigOverrides()
Returns
TypeDescription
Map<String,ParsingConfig>

getParsingConfigOverridesCount()

public int getParsingConfigOverridesCount()

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 or layout parsing are supported.
  • docx: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.

map<string, .google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig> parsing_config_overrides = 5;

Returns
TypeDescription
int

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 or layout parsing are supported.
  • docx: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.

map<string, .google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig> parsing_config_overrides = 5;

Returns
TypeDescription
Map<String,ParsingConfig>

getParsingConfigOverridesOrDefault(String key, DocumentProcessingConfig.ParsingConfig defaultValue)

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 or layout parsing are supported.
  • docx: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.

map<string, .google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig> parsing_config_overrides = 5;

Parameters
NameDescription
keyString
defaultValueDocumentProcessingConfig.ParsingConfig
Returns
TypeDescription
DocumentProcessingConfig.ParsingConfig

getParsingConfigOverridesOrThrow(String key)

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 or layout parsing are supported.
  • docx: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.

map<string, .google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig> parsing_config_overrides = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
DocumentProcessingConfig.ParsingConfig

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasChunkingConfig()

public boolean hasChunkingConfig()

Whether chunking mode is enabled.

.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ChunkingConfig chunking_config = 3;

Returns
TypeDescription
boolean

Whether the chunkingConfig field is set.

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.v1alpha.DocumentProcessingConfig.ParsingConfig default_parsing_config = 4;

Returns
TypeDescription
boolean

Whether the defaultParsingConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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