com.google.cloud.discoveryengine.v1alpha

Class DocumentProcessingConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig

All Implemented Interfaces:

DocumentProcessingConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class DocumentProcessingConfig
extends com.google.protobuf.GeneratedMessageV3
implements DocumentProcessingConfigOrBuilder

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

Protobuf type google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentProcessingConfig.Builder A singleton resource of [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
static class	DocumentProcessingConfig.ChunkingConfig Configuration for chunking config.
static interface	DocumentProcessingConfig.ChunkingConfigOrBuilder
static class	DocumentProcessingConfig.ParsingConfig Related configurations applied to a specific type of document parser.
static interface	DocumentProcessingConfig.ParsingConfigOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHUNKING_CONFIG_FIELD_NUMBER
static int	DEFAULT_PARSING_CONFIG_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PARSING_CONFIG_OVERRIDES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsParsingConfigOverrides(String key) Map from file type to override the default parsing configuration based on the file type.
boolean	equals(Object obj)
DocumentProcessingConfig.ChunkingConfig	getChunkingConfig() Whether chunking mode is enabled.
DocumentProcessingConfig.ChunkingConfigOrBuilder	getChunkingConfigOrBuilder() Whether chunking mode is enabled.
static DocumentProcessingConfig	getDefaultInstance()
DocumentProcessingConfig	getDefaultInstanceForType()
DocumentProcessingConfig.ParsingConfig	getDefaultParsingConfig() Configurations for default Document parser.
DocumentProcessingConfig.ParsingConfigOrBuilder	getDefaultParsingConfigOrBuilder() Configurations for default Document parser.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getName() The full resource name of the Document Processing Config.
com.google.protobuf.ByteString	getNameBytes() The full resource name of the Document Processing Config.
com.google.protobuf.Parser<DocumentProcessingConfig>	getParserForType()
Map<String,DocumentProcessingConfig.ParsingConfig>	getParsingConfigOverrides() Deprecated.
int	getParsingConfigOverridesCount() Map from file type to override the default parsing configuration based on the file type.
Map<String,DocumentProcessingConfig.ParsingConfig>	getParsingConfigOverridesMap() Map from file type to override the default parsing configuration based on the file type.
DocumentProcessingConfig.ParsingConfig	getParsingConfigOverridesOrDefault(String key, DocumentProcessingConfig.ParsingConfig defaultValue) Map from file type to override the default parsing configuration based on the file type.
DocumentProcessingConfig.ParsingConfig	getParsingConfigOverridesOrThrow(String key) Map from file type to override the default parsing configuration based on the file type.
int	getSerializedSize()
boolean	hasChunkingConfig() Whether chunking mode is enabled.
boolean	hasDefaultParsingConfig() Configurations for default Document parser.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static DocumentProcessingConfig.Builder	newBuilder()
static DocumentProcessingConfig.Builder	newBuilder(DocumentProcessingConfig prototype)
DocumentProcessingConfig.Builder	newBuilderForType()
protected DocumentProcessingConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DocumentProcessingConfig	parseDelimitedFrom(InputStream input)
static DocumentProcessingConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentProcessingConfig	parseFrom(byte[] data)
static DocumentProcessingConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentProcessingConfig	parseFrom(ByteBuffer data)
static DocumentProcessingConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentProcessingConfig	parseFrom(com.google.protobuf.ByteString data)
static DocumentProcessingConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentProcessingConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static DocumentProcessingConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentProcessingConfig	parseFrom(InputStream input)
static DocumentProcessingConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DocumentProcessingConfig>	parser()
DocumentProcessingConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

CHUNKING_CONFIG_FIELD_NUMBER

public static final int CHUNKING_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

DEFAULT_PARSING_CONFIG_FIELD_NUMBER

public static final int DEFAULT_PARSING_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

PARSING_CONFIG_OVERRIDES_FIELD_NUMBER

public static final int PARSING_CONFIG_OVERRIDES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.
 * `xlsx`: Override parsing config for XLSX files, only digital parsing and
 layout parsing are supported.
 

map<string, .google.cloud.discoveryengine.v1alpha.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.
 * `xlsx`: Override parsing config for XLSX files, only digital parsing and
 layout parsing are supported.
 

map<string, .google.cloud.discoveryengine.v1alpha.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.
 * `xlsx`: Override parsing config for XLSX files, only digital parsing and
 layout parsing are supported.
 

map<string, .google.cloud.discoveryengine.v1alpha.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.
 * `xlsx`: Override parsing config for XLSX files, only digital parsing and
 layout parsing are supported.
 

map<string, .google.cloud.discoveryengine.v1alpha.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.
 * `xlsx`: Override parsing config for XLSX files, only digital parsing and
 layout parsing are supported.
 

map<string, .google.cloud.discoveryengine.v1alpha.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.GeneratedMessageV3

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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

getDefaultInstanceForType

public DocumentProcessingConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder