Package com.google.cloud.documentai.v1beta3

Class Dataset

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1beta3.Dataset
All Implemented Interfaces:
DatasetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Dataset extends com.google.protobuf.GeneratedMessage 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:

  • Field Details

    • GCS_MANAGED_CONFIG_FIELD_NUMBER

      public static final int GCS_MANAGED_CONFIG_FIELD_NUMBER
      See Also:

    • DOCUMENT_WAREHOUSE_CONFIG_FIELD_NUMBER

      public static final int DOCUMENT_WAREHOUSE_CONFIG_FIELD_NUMBER
      See Also:

    • UNMANAGED_DATASET_CONFIG_FIELD_NUMBER

      public static final int UNMANAGED_DATASET_CONFIG_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • SATISFIES_PZS_FIELD_NUMBER

      public static final int SATISFIES_PZS_FIELD_NUMBER
      See Also:

    • SATISFIES_PZI_FIELD_NUMBER

      public static final int SATISFIES_PZI_FIELD_NUMBER
      See Also:

  • 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

    • getStorageSourceCase

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

    • 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

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

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

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

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

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

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

    • isInitialized

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

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

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Dataset parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Dataset parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static Dataset.Builder newBuilder()

    • newBuilder

      public static Dataset.Builder newBuilder(Dataset prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

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

    • getDefaultInstanceForType

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