Package com.google.cloud.documentai.v1beta3

Class Dataset.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Dataset.Builder>
com.google.cloud.documentai.v1beta3.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.GeneratedMessage.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 Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

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

    • mergeFrom

      public Dataset.Builder mergeFrom(Dataset other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.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

    • getStorageSourceCase

      public Dataset.StorageSourceCase getStorageSourceCase()
      Specified by:
      getStorageSourceCase in interface DatasetOrBuilder

    • clearStorageSource

      public Dataset.Builder clearStorageSource()

    • 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

      @Deprecated public boolean hasDocumentWarehouseConfig()
      Deprecated.
      google.cloud.documentai.v1beta3.Dataset.document_warehouse_config is deprecated. See google/cloud/documentai/v1beta3/dataset.proto;l=95
       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];
      Specified by:
      hasDocumentWarehouseConfig in interface DatasetOrBuilder
      Returns:
      Whether the documentWarehouseConfig field is set.

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

    • setDocumentWarehouseConfig

      @Deprecated public Dataset.Builder setDocumentWarehouseConfig(Dataset.DocumentWarehouseConfig value)
      Deprecated.
       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];

    • setDocumentWarehouseConfig

      @Deprecated public Dataset.Builder setDocumentWarehouseConfig(Dataset.DocumentWarehouseConfig.Builder builderForValue)
      Deprecated.
       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];

    • mergeDocumentWarehouseConfig

      @Deprecated public Dataset.Builder mergeDocumentWarehouseConfig(Dataset.DocumentWarehouseConfig value)
      Deprecated.
       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];

    • clearDocumentWarehouseConfig

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

    • getDocumentWarehouseConfigBuilder

      @Deprecated public Dataset.DocumentWarehouseConfig.Builder getDocumentWarehouseConfigBuilder()
      Deprecated.
       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

      @Deprecated public Dataset.DocumentWarehouseConfigOrBuilder getDocumentWarehouseConfigOrBuilder()
      Deprecated.
       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];
      Specified by:
      getDocumentWarehouseConfigOrBuilder in interface DatasetOrBuilder

    • 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

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

    • getSatisfiesPzs

      public boolean getSatisfiesPzs()
       Output only. Reserved for future use.
      bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzs in interface DatasetOrBuilder
      Returns:
      The satisfiesPzs.

    • setSatisfiesPzs

      public Dataset.Builder setSatisfiesPzs(boolean value)
       Output only. Reserved for future use.
      bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The satisfiesPzs to set.
      Returns:
      This builder for chaining.

    • clearSatisfiesPzs

      public Dataset.Builder clearSatisfiesPzs()
       Output only. Reserved for future use.
      bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • getSatisfiesPzi

      public boolean getSatisfiesPzi()
       Output only. Reserved for future use.
      bool satisfies_pzi = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzi in interface DatasetOrBuilder
      Returns:
      The satisfiesPzi.

    • setSatisfiesPzi

      public Dataset.Builder setSatisfiesPzi(boolean value)
       Output only. Reserved for future use.
      bool satisfies_pzi = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The satisfiesPzi to set.
      Returns:
      This builder for chaining.

    • clearSatisfiesPzi

      public Dataset.Builder clearSatisfiesPzi()
       Output only. Reserved for future use.
      bool satisfies_pzi = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.