Class Dataset (2.56.0)

Version 2.56.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public final class Dataset extends GeneratedMessageV3 implements DatasetOrBuilder

A singleton resource under a Processor which configures a collection of documents.

Protobuf type google.cloud.documentai.v1beta3.Dataset

Inheritance

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

Implements

DatasetOrBuilder

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

DOCUMENT_WAREHOUSE_CONFIG_FIELD_NUMBER

public static final int DOCUMENT_WAREHOUSE_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

GCS_MANAGED_CONFIG_FIELD_NUMBER

public static final int GCS_MANAGED_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER

Field Value
Type	Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER

Field Value
Type	Description
int

SPANNER_INDEXING_CONFIG_FIELD_NUMBER

public static final int SPANNER_INDEXING_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
int

UNMANAGED_DATASET_CONFIG_FIELD_NUMBER

public static final int UNMANAGED_DATASET_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Dataset getDefaultInstance()

Returns
Type	Description
Dataset

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Dataset.Builder newBuilder()

Returns
Type	Description
Dataset.Builder

newBuilder(Dataset prototype)

public static Dataset.Builder newBuilder(Dataset prototype)

Parameter
Name	Description
prototype	Dataset

Returns
Type	Description
Dataset.Builder

parseDelimitedFrom(InputStream input)

public static Dataset parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Dataset

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Dataset parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Dataset

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Dataset parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Dataset

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Dataset

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Dataset parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Dataset

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Dataset parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Dataset

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Dataset parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Dataset

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Dataset parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Dataset

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Dataset parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Dataset

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Dataset parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Dataset

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Dataset parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Dataset

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Dataset parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Dataset

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Dataset> parser()

Returns
Type	Description
Parser<Dataset>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public Dataset getDefaultInstanceForType()

Returns
Type	Description
Dataset

getDocumentWarehouseConfig() (deprecated)

public Dataset.DocumentWarehouseConfig getDocumentWarehouseConfig()

Deprecated. google.cloud.documentai.v1beta3.Dataset.document_warehouse_config is deprecated. See google/cloud/documentai/v1beta3/dataset.proto;l=98

Optional. Deprecated. Warehouse-based dataset configuration is not supported.

.google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Dataset.DocumentWarehouseConfig	The documentWarehouseConfig.

getDocumentWarehouseConfigOrBuilder() (deprecated)

public Dataset.DocumentWarehouseConfigOrBuilder getDocumentWarehouseConfigOrBuilder()

Optional. Deprecated. Warehouse-based dataset configuration is not supported.

.google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Dataset.DocumentWarehouseConfigOrBuilder

getGcsManagedConfig()

public Dataset.GCSManagedConfig getGcsManagedConfig()

Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location.

.google.cloud.documentai.v1beta3.Dataset.GCSManagedConfig gcs_managed_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Dataset.GCSManagedConfig	The gcsManagedConfig.

getGcsManagedConfigOrBuilder()

public Dataset.GCSManagedConfigOrBuilder getGcsManagedConfigOrBuilder()

Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location.

.google.cloud.documentai.v1beta3.Dataset.GCSManagedConfig gcs_managed_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Dataset.GCSManagedConfigOrBuilder

getIndexingSourceCase()

public Dataset.IndexingSourceCase getIndexingSourceCase()

Returns
Type	Description
Dataset.IndexingSourceCase

getName()

public String getName()

Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<Dataset> getParserForType()

Returns
Type	Description
Parser<Dataset>

Overrides

GeneratedMessageV3.getParserForType()

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The satisfiesPzs.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSpannerIndexingConfig()

public Dataset.SpannerIndexingConfig getSpannerIndexingConfig()

Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search.

.google.cloud.documentai.v1beta3.Dataset.SpannerIndexingConfig spanner_indexing_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Dataset.SpannerIndexingConfig	The spannerIndexingConfig.

getSpannerIndexingConfigOrBuilder()

public Dataset.SpannerIndexingConfigOrBuilder getSpannerIndexingConfigOrBuilder()

Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search.

.google.cloud.documentai.v1beta3.Dataset.SpannerIndexingConfig spanner_indexing_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Dataset.SpannerIndexingConfigOrBuilder

getState()

public Dataset.State getState()

Required. State of the dataset. Ignored when updating dataset.

.google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Dataset.State	The state.

getStateValue()

public int getStateValue()

Required. State of the dataset. Ignored when updating dataset.

.google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getStorageSourceCase()

public Dataset.StorageSourceCase getStorageSourceCase()

Returns
Type	Description
Dataset.StorageSourceCase

getUnmanagedDatasetConfig()

public Dataset.UnmanagedDatasetConfig getUnmanagedDatasetConfig()

Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed).

.google.cloud.documentai.v1beta3.Dataset.UnmanagedDatasetConfig unmanaged_dataset_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Dataset.UnmanagedDatasetConfig	The unmanagedDatasetConfig.

getUnmanagedDatasetConfigOrBuilder()

public Dataset.UnmanagedDatasetConfigOrBuilder getUnmanagedDatasetConfigOrBuilder()

Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed).

.google.cloud.documentai.v1beta3.Dataset.UnmanagedDatasetConfig unmanaged_dataset_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Dataset.UnmanagedDatasetConfigOrBuilder

hasDocumentWarehouseConfig() (deprecated)

public boolean hasDocumentWarehouseConfig()

Deprecated. google.cloud.documentai.v1beta3.Dataset.document_warehouse_config is deprecated. See google/cloud/documentai/v1beta3/dataset.proto;l=98

Optional. Deprecated. Warehouse-based dataset configuration is not supported.

.google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the documentWarehouseConfig field is set.

hasGcsManagedConfig()

public boolean hasGcsManagedConfig()

Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location.

.google.cloud.documentai.v1beta3.Dataset.GCSManagedConfig gcs_managed_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the gcsManagedConfig field is set.

hasSpannerIndexingConfig()

public boolean hasSpannerIndexingConfig()

Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search.

.google.cloud.documentai.v1beta3.Dataset.SpannerIndexingConfig spanner_indexing_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the spannerIndexingConfig field is set.

hasUnmanagedDatasetConfig()

public boolean hasUnmanagedDatasetConfig()

Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed).

.google.cloud.documentai.v1beta3.Dataset.UnmanagedDatasetConfig unmanaged_dataset_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the unmanagedDatasetConfig 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()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Dataset.Builder newBuilderForType()

Returns
Type	Description
Dataset.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Dataset.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Dataset.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 Dataset.Builder toBuilder()

Returns
Type	Description
Dataset.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException