Package com.google.cloud.documentai.v1beta3

Class ImportDocumentsRequest.BatchDocumentsImportConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.documentai.v1beta3.ImportDocumentsRequest.BatchDocumentsImportConfig

All Implemented Interfaces:

ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

ImportDocumentsRequest

public static final class ImportDocumentsRequest.BatchDocumentsImportConfig
extends com.google.protobuf.GeneratedMessage
implements ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder

 Config for importing documents.
 Each batch can have its own dataset split type.
 

Protobuf type google.cloud.documentai.v1beta3.ImportDocumentsRequest.BatchDocumentsImportConfig

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImportDocumentsRequest.BatchDocumentsImportConfig.AutoSplitConfig	The config for auto-split.
static interface	ImportDocumentsRequest.BatchDocumentsImportConfig.AutoSplitConfigOrBuilder
static final class	ImportDocumentsRequest.BatchDocumentsImportConfig.Builder	Config for importing documents.
static enum	ImportDocumentsRequest.BatchDocumentsImportConfig.SplitTypeConfigCase

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

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessage.BuilderParent

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AUTO_SPLIT_CONFIG_FIELD_NUMBER
static final int	BATCH_INPUT_CONFIG_FIELD_NUMBER
static final int	DATASET_SPLIT_FIELD_NUMBER
static final int	DOCUMENT_TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, 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	Description
boolean	equals(Object obj)
ImportDocumentsRequest.BatchDocumentsImportConfig.AutoSplitConfig	getAutoSplitConfig()	If set, documents will be automatically split into training and test split category with the specified ratio.
ImportDocumentsRequest.BatchDocumentsImportConfig.AutoSplitConfigOrBuilder	getAutoSplitConfigOrBuilder()	If set, documents will be automatically split into training and test split category with the specified ratio.
BatchDocumentsInputConfig	getBatchInputConfig()	The common config to specify a set of documents used as input.
BatchDocumentsInputConfigOrBuilder	getBatchInputConfigOrBuilder()	The common config to specify a set of documents used as input.
DatasetSplitType	getDatasetSplit()	Target dataset split where the documents must be stored.
int	getDatasetSplitValue()	Target dataset split where the documents must be stored.
static ImportDocumentsRequest.BatchDocumentsImportConfig	getDefaultInstance()
ImportDocumentsRequest.BatchDocumentsImportConfig	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDocumentType()	Optional.
com.google.protobuf.ByteString	getDocumentTypeBytes()	Optional.
com.google.protobuf.Parser<ImportDocumentsRequest.BatchDocumentsImportConfig>	getParserForType()
int	getSerializedSize()
ImportDocumentsRequest.BatchDocumentsImportConfig.SplitTypeConfigCase	getSplitTypeConfigCase()
boolean	hasAutoSplitConfig()	If set, documents will be automatically split into training and test split category with the specified ratio.
boolean	hasBatchInputConfig()	The common config to specify a set of documents used as input.
boolean	hasDatasetSplit()	Target dataset split where the documents must be stored.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static ImportDocumentsRequest.BatchDocumentsImportConfig.Builder	newBuilder()
static ImportDocumentsRequest.BatchDocumentsImportConfig.Builder	newBuilder(ImportDocumentsRequest.BatchDocumentsImportConfig prototype)
ImportDocumentsRequest.BatchDocumentsImportConfig.Builder	newBuilderForType()
protected ImportDocumentsRequest.BatchDocumentsImportConfig.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static ImportDocumentsRequest.BatchDocumentsImportConfig	parseDelimitedFrom(InputStream input)
static ImportDocumentsRequest.BatchDocumentsImportConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ImportDocumentsRequest.BatchDocumentsImportConfig	parseFrom(byte[] data)
static ImportDocumentsRequest.BatchDocumentsImportConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ImportDocumentsRequest.BatchDocumentsImportConfig	parseFrom(com.google.protobuf.ByteString data)
static ImportDocumentsRequest.BatchDocumentsImportConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ImportDocumentsRequest.BatchDocumentsImportConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static ImportDocumentsRequest.BatchDocumentsImportConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ImportDocumentsRequest.BatchDocumentsImportConfig	parseFrom(InputStream input)
static ImportDocumentsRequest.BatchDocumentsImportConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ImportDocumentsRequest.BatchDocumentsImportConfig	parseFrom(ByteBuffer data)
static ImportDocumentsRequest.BatchDocumentsImportConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ImportDocumentsRequest.BatchDocumentsImportConfig>	parser()
ImportDocumentsRequest.BatchDocumentsImportConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

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

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

DATASET_SPLIT_FIELD_NUMBER

public static final int DATASET_SPLIT_FIELD_NUMBER

See Also:

• Constant Field Values

AUTO_SPLIT_CONFIG_FIELD_NUMBER

public static final int AUTO_SPLIT_CONFIG_FIELD_NUMBER

See Also:

• Constant Field Values

BATCH_INPUT_CONFIG_FIELD_NUMBER

public static final int BATCH_INPUT_CONFIG_FIELD_NUMBER

See Also:

• Constant Field Values

DOCUMENT_TYPE_FIELD_NUMBER

public static final int DOCUMENT_TYPE_FIELD_NUMBER

See Also:

• Constant Field Values

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

getSplitTypeConfigCase

public ImportDocumentsRequest.BatchDocumentsImportConfig.SplitTypeConfigCase getSplitTypeConfigCase()

Specified by:

getSplitTypeConfigCase in interface ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder

hasDatasetSplit

public boolean hasDatasetSplit()

 Target dataset split where the documents must be stored.
 

.google.cloud.documentai.v1beta3.DatasetSplitType dataset_split = 2;

Specified by:

hasDatasetSplit in interface ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder

Returns:

Whether the datasetSplit field is set.

getDatasetSplitValue

public int getDatasetSplitValue()

 Target dataset split where the documents must be stored.
 

.google.cloud.documentai.v1beta3.DatasetSplitType dataset_split = 2;

Specified by:

getDatasetSplitValue in interface ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder

Returns:

The enum numeric value on the wire for datasetSplit.

getDatasetSplit

public DatasetSplitType getDatasetSplit()

 Target dataset split where the documents must be stored.
 

.google.cloud.documentai.v1beta3.DatasetSplitType dataset_split = 2;

Specified by:

getDatasetSplit in interface ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder

Returns:

The datasetSplit.

hasAutoSplitConfig

public boolean hasAutoSplitConfig()

 If set, documents will be automatically split into training and test
 split category with the specified ratio.
 

.google.cloud.documentai.v1beta3.ImportDocumentsRequest.BatchDocumentsImportConfig.AutoSplitConfig auto_split_config = 3;

Specified by:

hasAutoSplitConfig in interface ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder

Returns:

Whether the autoSplitConfig field is set.

getAutoSplitConfig

public ImportDocumentsRequest.BatchDocumentsImportConfig.AutoSplitConfig getAutoSplitConfig()

 If set, documents will be automatically split into training and test
 split category with the specified ratio.
 

.google.cloud.documentai.v1beta3.ImportDocumentsRequest.BatchDocumentsImportConfig.AutoSplitConfig auto_split_config = 3;

Specified by:

getAutoSplitConfig in interface ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder

Returns:

The autoSplitConfig.

getAutoSplitConfigOrBuilder

public ImportDocumentsRequest.BatchDocumentsImportConfig.AutoSplitConfigOrBuilder getAutoSplitConfigOrBuilder()

 If set, documents will be automatically split into training and test
 split category with the specified ratio.
 

.google.cloud.documentai.v1beta3.ImportDocumentsRequest.BatchDocumentsImportConfig.AutoSplitConfig auto_split_config = 3;

Specified by:

getAutoSplitConfigOrBuilder in interface ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder

hasBatchInputConfig

public boolean hasBatchInputConfig()

 The common config to specify a set of documents used as input.
 

.google.cloud.documentai.v1beta3.BatchDocumentsInputConfig batch_input_config = 1;

Specified by:

hasBatchInputConfig in interface ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder

Returns:

Whether the batchInputConfig field is set.

getBatchInputConfig

public BatchDocumentsInputConfig getBatchInputConfig()

 The common config to specify a set of documents used as input.
 

.google.cloud.documentai.v1beta3.BatchDocumentsInputConfig batch_input_config = 1;

Specified by:

getBatchInputConfig in interface ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder

Returns:

The batchInputConfig.

getBatchInputConfigOrBuilder

public BatchDocumentsInputConfigOrBuilder getBatchInputConfigOrBuilder()

 The common config to specify a set of documents used as input.
 

.google.cloud.documentai.v1beta3.BatchDocumentsInputConfig batch_input_config = 1;

Specified by:

getBatchInputConfigOrBuilder in interface ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder

getDocumentType

public String getDocumentType()

 Optional. If set, determines the type of the documents to be imported in
 this batch. It can be used to auto-label the documents with a single
 entity of the provided type. This field can only be used with a
 classifier or splitter processor. Providing this field is mutually
 exclusive with `entities` and `auto_labeling_config`.
 

string document_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDocumentType in interface ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder

Returns:

The documentType.

getDocumentTypeBytes

public com.google.protobuf.ByteString getDocumentTypeBytes()

 Optional. If set, determines the type of the documents to be imported in
 this batch. It can be used to auto-label the documents with a single
 entity of the provided type. This field can only be used with a
 classifier or splitter processor. Providing this field is mutually
 exclusive with `entities` and `auto_labeling_config`.
 

string document_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDocumentTypeBytes in interface ImportDocumentsRequest.BatchDocumentsImportConfigOrBuilder

Returns:

The bytes for documentType.

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 ImportDocumentsRequest.BatchDocumentsImportConfig parseFrom(ByteBuffer data)
                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ImportDocumentsRequest.BatchDocumentsImportConfig parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ImportDocumentsRequest.BatchDocumentsImportConfig parseFrom(com.google.protobuf.ByteString data)
                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ImportDocumentsRequest.BatchDocumentsImportConfig parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ImportDocumentsRequest.BatchDocumentsImportConfig parseFrom(byte[] data)
                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ImportDocumentsRequest.BatchDocumentsImportConfig parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ImportDocumentsRequest.BatchDocumentsImportConfig parseFrom(InputStream input)
                                                                   throws IOException

Throws:

IOException

parseFrom

public static ImportDocumentsRequest.BatchDocumentsImportConfig parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static ImportDocumentsRequest.BatchDocumentsImportConfig parseDelimitedFrom(InputStream input)
                                                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static ImportDocumentsRequest.BatchDocumentsImportConfig parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                            throws IOException

Throws:

IOException

parseFrom

public static ImportDocumentsRequest.BatchDocumentsImportConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                                                   throws IOException

Throws:

IOException

parseFrom

public static ImportDocumentsRequest.BatchDocumentsImportConfig parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                   throws IOException

Throws:

IOException

newBuilderForType

public ImportDocumentsRequest.BatchDocumentsImportConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ImportDocumentsRequest.BatchDocumentsImportConfig.Builder newBuilder()

newBuilder

public static ImportDocumentsRequest.BatchDocumentsImportConfig.Builder newBuilder(ImportDocumentsRequest.BatchDocumentsImportConfig prototype)

toBuilder

public ImportDocumentsRequest.BatchDocumentsImportConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ImportDocumentsRequest.BatchDocumentsImportConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static ImportDocumentsRequest.BatchDocumentsImportConfig getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ImportDocumentsRequest.BatchDocumentsImportConfig> 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 ImportDocumentsRequest.BatchDocumentsImportConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder