Class DocumentProcessingConfig (0.51.0)

Version latest

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public final class DocumentProcessingConfig extends GeneratedMessageV3 implements DocumentProcessingConfigOrBuilder

A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.

Protobuf type google.cloud.discoveryengine.v1beta.DocumentProcessingConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentProcessingConfig

Implements

DocumentProcessingConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CHUNKING_CONFIG_FIELD_NUMBER

public static final int CHUNKING_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

DEFAULT_PARSING_CONFIG_FIELD_NUMBER

public static final int DEFAULT_PARSING_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

PARSING_CONFIG_OVERRIDES_FIELD_NUMBER

public static final int PARSING_CONFIG_OVERRIDES_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static DocumentProcessingConfig getDefaultInstance()

Returns
Type	Description
DocumentProcessingConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static DocumentProcessingConfig.Builder newBuilder()

Returns
Type	Description
DocumentProcessingConfig.Builder

newBuilder(DocumentProcessingConfig prototype)

public static DocumentProcessingConfig.Builder newBuilder(DocumentProcessingConfig prototype)

Parameter
Name	Description
prototype	DocumentProcessingConfig

Returns
Type	Description
DocumentProcessingConfig.Builder

parseDelimitedFrom(InputStream input)

public static DocumentProcessingConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DocumentProcessingConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentProcessingConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentProcessingConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static DocumentProcessingConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
DocumentProcessingConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentProcessingConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentProcessingConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentProcessingConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
DocumentProcessingConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentProcessingConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentProcessingConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentProcessingConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
DocumentProcessingConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentProcessingConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentProcessingConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static DocumentProcessingConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DocumentProcessingConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentProcessingConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentProcessingConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static DocumentProcessingConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
DocumentProcessingConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentProcessingConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentProcessingConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<DocumentProcessingConfig> parser()

Returns
Type	Description
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 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;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getChunkingConfig()

public DocumentProcessingConfig.ChunkingConfig getChunkingConfig()

Whether chunking mode is enabled.

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

Returns
Type	Description
DocumentProcessingConfig.ChunkingConfig	The chunkingConfig.

getChunkingConfigOrBuilder()

public DocumentProcessingConfig.ChunkingConfigOrBuilder getChunkingConfigOrBuilder()

Whether chunking mode is enabled.

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

Returns
Type	Description
DocumentProcessingConfig.ChunkingConfigOrBuilder

getDefaultInstanceForType()

public DocumentProcessingConfig getDefaultInstanceForType()

Returns
Type	Description
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.v1beta.DocumentProcessingConfig.ParsingConfig default_parsing_config = 4;

Returns
Type	Description
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.v1beta.DocumentProcessingConfig.ParsingConfig default_parsing_config = 4;

Returns
Type	Description
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
Type	Description
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
Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<DocumentProcessingConfig> getParserForType()

Returns
Type	Description
Parser<DocumentProcessingConfig>

Overrides

GeneratedMessageV3.getParserForType()

getParsingConfigOverrides() (deprecated)

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

Use #getParsingConfigOverridesMap() instead.

Returns
Type	Description
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 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;

Returns
Type	Description
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 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;

Returns
Type	Description
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 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;

Parameters
Name	Description
key	String
defaultValue	DocumentProcessingConfig.ParsingConfig

Returns
Type	Description
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 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;

Parameter
Name	Description
key	String

Returns
Type	Description
DocumentProcessingConfig.ParsingConfig

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hasChunkingConfig()

public boolean hasChunkingConfig()

Whether chunking mode is enabled.

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

Returns
Type	Description
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.v1beta.DocumentProcessingConfig.ParsingConfig default_parsing_config = 4;

Returns
Type	Description
boolean	Whether the defaultParsingConfig field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public DocumentProcessingConfig.Builder newBuilderForType()

Returns
Type	Description
DocumentProcessingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentProcessingConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
DocumentProcessingConfig.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public DocumentProcessingConfig.Builder toBuilder()

Returns
Type	Description
DocumentProcessingConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException