Send feedback
Class Dataset (2.32.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.32.0 keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
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
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Dataset . Builder newBuilder ()
newBuilder(Dataset prototype)
public static Dataset . Builder newBuilder ( Dataset prototype )
Parameter Name Description prototype
Dataset
public static Dataset parseDelimitedFrom ( InputStream input )
public static Dataset parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Dataset parseFrom ( byte [] data )
Parameter Name Description data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Dataset parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Dataset parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Dataset parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Dataset parseFrom ( CodedInputStream input )
public static Dataset parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Dataset parseFrom ( InputStream input )
public static Dataset parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Dataset parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Dataset parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Dataset> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description obj
Object
Overrides
getDefaultInstanceForType()
public Dataset getDefaultInstanceForType ()
getDocumentWarehouseConfig()
public Dataset . DocumentWarehouseConfig getDocumentWarehouseConfig ()
Optional. Document AI Warehouse-based dataset configuration.
.google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [(.google.api.field_behavior) = OPTIONAL];
getDocumentWarehouseConfigOrBuilder()
public Dataset . DocumentWarehouseConfigOrBuilder getDocumentWarehouseConfigOrBuilder ()
Optional. Document AI Warehouse-based dataset configuration.
.google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
getIndexingSourceCase()
public Dataset . IndexingSourceCase getIndexingSourceCase ()
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 ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
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];
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];
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];
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 ()
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];
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];
hasDocumentWarehouseConfig()
public boolean hasDocumentWarehouseConfig ()
Optional. Document AI Warehouse-based dataset configuration.
.google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [(.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()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Dataset . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Dataset . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public Dataset . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]