Package com.google.cloud.documentai.v1beta3

Class Dataset

  • All Implemented Interfaces:
    DatasetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    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
    See Also:
    Serialized Form

    • Field Detail

      • GCS_MANAGED_CONFIG_FIELD_NUMBER

        public static final int GCS_MANAGED_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_WAREHOUSE_CONFIG_FIELD_NUMBER

        public static final int DOCUMENT_WAREHOUSE_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UNMANAGED_DATASET_CONFIG_FIELD_NUMBER

        public static final int UNMANAGED_DATASET_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SPANNER_INDEXING_CONFIG_FIELD_NUMBER

        public static final int SPANNER_INDEXING_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        hasGcsManagedConfig in interface DatasetOrBuilder
        Returns:
        Whether the gcsManagedConfig field is set.

      • 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];
        Specified by:
        getGcsManagedConfig in interface DatasetOrBuilder
        Returns:
        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];
        Specified by:
        getGcsManagedConfigOrBuilder in interface DatasetOrBuilder

      • 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];
        Specified by:
        hasDocumentWarehouseConfig in interface DatasetOrBuilder
        Returns:
        Whether the documentWarehouseConfig field is set.

      • 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];
        Specified by:
        getDocumentWarehouseConfig in interface DatasetOrBuilder
        Returns:
        The documentWarehouseConfig.

      • 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];
        Specified by:
        hasUnmanagedDatasetConfig in interface DatasetOrBuilder
        Returns:
        Whether the unmanagedDatasetConfig field is set.

      • 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];
        Specified by:
        getUnmanagedDatasetConfig in interface DatasetOrBuilder
        Returns:
        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];
        Specified by:
        getUnmanagedDatasetConfigOrBuilder in interface DatasetOrBuilder

      • 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];
        Specified by:
        hasSpannerIndexingConfig in interface DatasetOrBuilder
        Returns:
        Whether the spannerIndexingConfig field is set.

      • 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];
        Specified by:
        getSpannerIndexingConfig in interface DatasetOrBuilder
        Returns:
        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];
        Specified by:
        getSpannerIndexingConfigOrBuilder in interface DatasetOrBuilder

      • getName

        public String getName()
         Dataset resource name.
 Format:
 `projects/{project}/locations/{location}/processors/{processor}/dataset`
        string name = 1;
        Specified by:
        getName in interface DatasetOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Dataset resource name.
 Format:
 `projects/{project}/locations/{location}/processors/{processor}/dataset`
        string name = 1;
        Specified by:
        getNameBytes in interface DatasetOrBuilder
        Returns:
        The bytes for name.

      • 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];
        Specified by:
        getStateValue in interface DatasetOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • 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];
        Specified by:
        getState in interface DatasetOrBuilder
        Returns:
        The state.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • 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 Dataset parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Dataset parseFrom​(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Dataset parseFrom​(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Dataset parseFrom​(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Dataset parseFrom​(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Dataset parseFrom​(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Dataset parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Dataset.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Dataset.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Dataset.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Dataset getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Dataset> 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.GeneratedMessageV3

      • getDefaultInstanceForType

        public Dataset getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder