public final class Dataset extends com.google.protobuf.GeneratedMessageV3 implements DatasetOrBuilder
A singleton resource under a [Processor][google.cloud.documentai.v1beta3.Processor] which configures a collection of documents.Protobuf type
google.cloud.documentai.v1beta3.Dataset| Modifier and Type | Class and Description |
|---|---|
static class |
Dataset.Builder
A singleton resource under a
[Processor][google.cloud.documentai.v1beta3.Processor] which configures a
collection of documents.
|
static class |
Dataset.DocumentWarehouseConfig
Configuration specific to the Document AI Warehouse-based implementation.
|
static interface |
Dataset.DocumentWarehouseConfigOrBuilder |
static class |
Dataset.GCSManagedConfig
Configuration specific to the Cloud Storage-based implementation.
|
static interface |
Dataset.GCSManagedConfigOrBuilder |
static class |
Dataset.IndexingSourceCase |
static class |
Dataset.SpannerIndexingConfig
Configuration specific to spanner-based indexing.
|
static interface |
Dataset.SpannerIndexingConfigOrBuilder |
static class |
Dataset.State
Different states of a dataset.
|
static class |
Dataset.StorageSourceCase |
static class |
Dataset.UnmanagedDatasetConfig
Configuration specific to an unmanaged dataset.
|
static interface |
Dataset.UnmanagedDatasetConfigOrBuilder |
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| Modifier and Type | Field and Description |
|---|---|
static int |
DOCUMENT_WAREHOUSE_CONFIG_FIELD_NUMBER |
static int |
GCS_MANAGED_CONFIG_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
SATISFIES_PZI_FIELD_NUMBER |
static int |
SATISFIES_PZS_FIELD_NUMBER |
static int |
SPANNER_INDEXING_CONFIG_FIELD_NUMBER |
static int |
STATE_FIELD_NUMBER |
static int |
UNMANAGED_DATASET_CONFIG_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static Dataset |
getDefaultInstance() |
Dataset |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Dataset.DocumentWarehouseConfig |
getDocumentWarehouseConfig()
Deprecated.
google.cloud.documentai.v1beta3.Dataset.document_warehouse_config is deprecated.
See google/cloud/documentai/v1beta3/dataset.proto;l=98
|
Dataset.DocumentWarehouseConfigOrBuilder |
getDocumentWarehouseConfigOrBuilder()
Deprecated.
|
Dataset.GCSManagedConfig |
getGcsManagedConfig()
Optional.
|
Dataset.GCSManagedConfigOrBuilder |
getGcsManagedConfigOrBuilder()
Optional.
|
Dataset.IndexingSourceCase |
getIndexingSourceCase() |
String |
getName()
Dataset resource name.
|
com.google.protobuf.ByteString |
getNameBytes()
Dataset resource name.
|
com.google.protobuf.Parser<Dataset> |
getParserForType() |
boolean |
getSatisfiesPzi()
Output only.
|
boolean |
getSatisfiesPzs()
Output only.
|
int |
getSerializedSize() |
Dataset.SpannerIndexingConfig |
getSpannerIndexingConfig()
Optional.
|
Dataset.SpannerIndexingConfigOrBuilder |
getSpannerIndexingConfigOrBuilder()
Optional.
|
Dataset.State |
getState()
Required.
|
int |
getStateValue()
Required.
|
Dataset.StorageSourceCase |
getStorageSourceCase() |
Dataset.UnmanagedDatasetConfig |
getUnmanagedDatasetConfig()
Optional.
|
Dataset.UnmanagedDatasetConfigOrBuilder |
getUnmanagedDatasetConfigOrBuilder()
Optional.
|
boolean |
hasDocumentWarehouseConfig()
Deprecated.
google.cloud.documentai.v1beta3.Dataset.document_warehouse_config is deprecated.
See google/cloud/documentai/v1beta3/dataset.proto;l=98
|
boolean |
hasGcsManagedConfig()
Optional.
|
int |
hashCode() |
boolean |
hasSpannerIndexingConfig()
Optional.
|
boolean |
hasUnmanagedDatasetConfig()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Dataset.Builder |
newBuilder() |
static Dataset.Builder |
newBuilder(Dataset prototype) |
Dataset.Builder |
newBuilderForType() |
protected Dataset.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Dataset |
parseDelimitedFrom(InputStream input) |
static Dataset |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Dataset |
parseFrom(byte[] data) |
static Dataset |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Dataset |
parseFrom(ByteBuffer data) |
static Dataset |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Dataset |
parseFrom(com.google.protobuf.ByteString data) |
static Dataset |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Dataset |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Dataset |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Dataset |
parseFrom(InputStream input) |
static Dataset |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Dataset> |
parser() |
Dataset.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int GCS_MANAGED_CONFIG_FIELD_NUMBER
public static final int DOCUMENT_WAREHOUSE_CONFIG_FIELD_NUMBER
public static final int UNMANAGED_DATASET_CONFIG_FIELD_NUMBER
public static final int SPANNER_INDEXING_CONFIG_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER
public static final int SATISFIES_PZI_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public Dataset.StorageSourceCase getStorageSourceCase()
getStorageSourceCase in interface DatasetOrBuilderpublic Dataset.IndexingSourceCase getIndexingSourceCase()
getIndexingSourceCase in interface DatasetOrBuilderpublic 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];
hasGcsManagedConfig in interface DatasetOrBuilderpublic 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];
getGcsManagedConfig in interface DatasetOrBuilderpublic 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];
getGcsManagedConfigOrBuilder in interface DatasetOrBuilder@Deprecated public boolean hasDocumentWarehouseConfig()
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];
hasDocumentWarehouseConfig in interface DatasetOrBuilder@Deprecated public Dataset.DocumentWarehouseConfig getDocumentWarehouseConfig()
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];
getDocumentWarehouseConfig in interface DatasetOrBuilder@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];
getDocumentWarehouseConfigOrBuilder in interface DatasetOrBuilderpublic 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];
hasUnmanagedDatasetConfig in interface DatasetOrBuilderpublic 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];
getUnmanagedDatasetConfig in interface DatasetOrBuilderpublic 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];
getUnmanagedDatasetConfigOrBuilder in interface DatasetOrBuilderpublic 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];
hasSpannerIndexingConfig in interface DatasetOrBuilderpublic 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];
getSpannerIndexingConfig in interface DatasetOrBuilderpublic 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];
getSpannerIndexingConfigOrBuilder in interface DatasetOrBuilderpublic String getName()
Dataset resource name.
Format:
`projects/{project}/locations/{location}/processors/{processor}/dataset`
string name = 1;getName in interface DatasetOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Dataset resource name.
Format:
`projects/{project}/locations/{location}/processors/{processor}/dataset`
string name = 1;getNameBytes in interface DatasetOrBuilderpublic int getStateValue()
Required. State of the dataset. Ignored when updating dataset.
.google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];
getStateValue in interface DatasetOrBuilderpublic 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];
getState in interface DatasetOrBuilderpublic boolean getSatisfiesPzs()
Output only. Reserved for future use.
bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];getSatisfiesPzs in interface DatasetOrBuilderpublic boolean getSatisfiesPzi()
Output only. Reserved for future use.
bool satisfies_pzi = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];getSatisfiesPzi in interface DatasetOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Dataset parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Dataset parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Dataset parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Dataset parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Dataset parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Dataset parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Dataset parseFrom(InputStream input) throws IOException
IOExceptionpublic static Dataset parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Dataset parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Dataset parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Dataset parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Dataset parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Dataset.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Dataset.Builder newBuilder()
public static Dataset.Builder newBuilder(Dataset prototype)
public Dataset.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Dataset.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Dataset getDefaultInstance()
public static com.google.protobuf.Parser<Dataset> parser()
public com.google.protobuf.Parser<Dataset> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Dataset getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.