Package com.google.cloud.documentai.v1beta3

Class Dataset.Builder

  • All Implemented Interfaces:
    DatasetOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Dataset
    public static final class Dataset.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Dataset.Builder>
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

    • Method Detail

      • 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.Builder<Dataset.Builder>

      • clear

        public Dataset.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Dataset.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Dataset.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Dataset.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Dataset.Builder>

      • setField

        public Dataset.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Dataset.Builder>

      • clearField

        public Dataset.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Dataset.Builder>

      • clearOneof

        public Dataset.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Dataset.Builder>

      • setRepeatedField

        public Dataset.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        int index,
                                        Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Dataset.Builder>

      • addRepeatedField

        public Dataset.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Dataset.Builder>

      • mergeFrom

        public Dataset.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Dataset.Builder>

      • isInitialized

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

      • mergeFrom

        public Dataset.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Dataset.Builder>
        Throws:
        IOException

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

      • setGcsManagedConfig

        public Dataset.Builder setGcsManagedConfig​(Dataset.GCSManagedConfig value)
         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];

      • setGcsManagedConfig

        public Dataset.Builder setGcsManagedConfig​(Dataset.GCSManagedConfig.Builder builderForValue)
         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];

      • mergeGcsManagedConfig

        public Dataset.Builder mergeGcsManagedConfig​(Dataset.GCSManagedConfig value)
         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];

      • clearGcsManagedConfig

        public Dataset.Builder clearGcsManagedConfig()
         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];

      • getGcsManagedConfigBuilder

        public Dataset.GCSManagedConfig.Builder getGcsManagedConfigBuilder()
         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];
        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.

      • setDocumentWarehouseConfig

        public Dataset.Builder setDocumentWarehouseConfig​(Dataset.DocumentWarehouseConfig value)
         Optional. Document AI Warehouse-based dataset configuration.
        .google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [(.google.api.field_behavior) = OPTIONAL];

      • setDocumentWarehouseConfig

        public Dataset.Builder setDocumentWarehouseConfig​(Dataset.DocumentWarehouseConfig.Builder builderForValue)
         Optional. Document AI Warehouse-based dataset configuration.
        .google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [(.google.api.field_behavior) = OPTIONAL];

      • mergeDocumentWarehouseConfig

        public Dataset.Builder mergeDocumentWarehouseConfig​(Dataset.DocumentWarehouseConfig value)
         Optional. Document AI Warehouse-based dataset configuration.
        .google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [(.google.api.field_behavior) = OPTIONAL];

      • clearDocumentWarehouseConfig

        public Dataset.Builder clearDocumentWarehouseConfig()
         Optional. Document AI Warehouse-based dataset configuration.
        .google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getDocumentWarehouseConfigBuilder

        public Dataset.DocumentWarehouseConfig.Builder getDocumentWarehouseConfigBuilder()
         Optional. Document AI Warehouse-based dataset configuration.
        .google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [(.google.api.field_behavior) = OPTIONAL];

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

      • setUnmanagedDatasetConfig

        public Dataset.Builder setUnmanagedDatasetConfig​(Dataset.UnmanagedDatasetConfig value)
         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];

      • setUnmanagedDatasetConfig

        public Dataset.Builder setUnmanagedDatasetConfig​(Dataset.UnmanagedDatasetConfig.Builder builderForValue)
         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];

      • mergeUnmanagedDatasetConfig

        public Dataset.Builder mergeUnmanagedDatasetConfig​(Dataset.UnmanagedDatasetConfig value)
         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];

      • clearUnmanagedDatasetConfig

        public Dataset.Builder clearUnmanagedDatasetConfig()
         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];

      • getUnmanagedDatasetConfigBuilder

        public Dataset.UnmanagedDatasetConfig.Builder getUnmanagedDatasetConfigBuilder()
         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];
        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.

      • setSpannerIndexingConfig

        public Dataset.Builder setSpannerIndexingConfig​(Dataset.SpannerIndexingConfig value)
         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];

      • setSpannerIndexingConfig

        public Dataset.Builder setSpannerIndexingConfig​(Dataset.SpannerIndexingConfig.Builder builderForValue)
         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];

      • mergeSpannerIndexingConfig

        public Dataset.Builder mergeSpannerIndexingConfig​(Dataset.SpannerIndexingConfig value)
         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];

      • clearSpannerIndexingConfig

        public Dataset.Builder clearSpannerIndexingConfig()
         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];

      • getSpannerIndexingConfigBuilder

        public Dataset.SpannerIndexingConfig.Builder getSpannerIndexingConfigBuilder()
         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];
        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.

      • setName

        public Dataset.Builder setName​(String value)
         Dataset resource name.
 Format:
 `projects/{project}/locations/{location}/processors/{processor}/dataset`
        string name = 1;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Dataset.Builder clearName()
         Dataset resource name.
 Format:
 `projects/{project}/locations/{location}/processors/{processor}/dataset`
        string name = 1;
        Returns:
        This builder for chaining.

      • setNameBytes

        public Dataset.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Dataset resource name.
 Format:
 `projects/{project}/locations/{location}/processors/{processor}/dataset`
        string name = 1;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

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

      • setStateValue

        public Dataset.Builder setStateValue​(int value)
         Required. State of the dataset. Ignored when updating dataset.
        .google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The enum numeric value on the wire for state to set.
        Returns:
        This builder for chaining.

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

      • setState

        public Dataset.Builder setState​(Dataset.State value)
         Required. State of the dataset. Ignored when updating dataset.
        .google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The state to set.
        Returns:
        This builder for chaining.

      • clearState

        public Dataset.Builder clearState()
         Required. State of the dataset. Ignored when updating dataset.
        .google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Dataset.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Dataset.Builder>

      • mergeUnknownFields

        public final Dataset.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Dataset.Builder>