Interface DatasetOrBuilder (2.52.0)

Version 2.52.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public interface DatasetOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDocumentWarehouseConfig() (deprecated)

public abstract Dataset.DocumentWarehouseConfig getDocumentWarehouseConfig()

Deprecated. google.cloud.documentai.v1beta3.Dataset.document_warehouse_config is deprecated. See google/cloud/documentai/v1beta3/dataset.proto;l=98

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];

Returns
Type	Description
Dataset.DocumentWarehouseConfig	The documentWarehouseConfig.

getDocumentWarehouseConfigOrBuilder() (deprecated)

public abstract 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];

Returns
Type	Description
Dataset.DocumentWarehouseConfigOrBuilder

getGcsManagedConfig()

public abstract 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];

Returns
Type	Description
Dataset.GCSManagedConfig	The gcsManagedConfig.

getGcsManagedConfigOrBuilder()

public abstract 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];

Returns
Type	Description
Dataset.GCSManagedConfigOrBuilder

getIndexingSourceCase()

public abstract Dataset.IndexingSourceCase getIndexingSourceCase()

Returns
Type	Description
Dataset.IndexingSourceCase

getName()

public abstract String getName()

Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getSatisfiesPzi()

public abstract boolean getSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The satisfiesPzi.

getSatisfiesPzs()

public abstract boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The satisfiesPzs.

getSpannerIndexingConfig()

public abstract 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];

Returns
Type	Description
Dataset.SpannerIndexingConfig	The spannerIndexingConfig.

getSpannerIndexingConfigOrBuilder()

public abstract 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];

Returns
Type	Description
Dataset.SpannerIndexingConfigOrBuilder

getState()

public abstract 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];

Returns
Type	Description
Dataset.State	The state.

getStateValue()

public abstract int getStateValue()

Required. State of the dataset. Ignored when updating dataset.

.google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getStorageSourceCase()

public abstract Dataset.StorageSourceCase getStorageSourceCase()

Returns
Type	Description
Dataset.StorageSourceCase

getUnmanagedDatasetConfig()

public abstract 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];

Returns
Type	Description
Dataset.UnmanagedDatasetConfig	The unmanagedDatasetConfig.

getUnmanagedDatasetConfigOrBuilder()

public abstract 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];

Returns
Type	Description
Dataset.UnmanagedDatasetConfigOrBuilder

hasDocumentWarehouseConfig() (deprecated)

public abstract boolean hasDocumentWarehouseConfig()

Deprecated. google.cloud.documentai.v1beta3.Dataset.document_warehouse_config is deprecated. See google/cloud/documentai/v1beta3/dataset.proto;l=98

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];

Returns
Type	Description
boolean	Whether the documentWarehouseConfig field is set.

hasGcsManagedConfig()

public abstract 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];

Returns
Type	Description
boolean	Whether the gcsManagedConfig field is set.

hasSpannerIndexingConfig()

public abstract 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];

Returns
Type	Description
boolean	Whether the spannerIndexingConfig field is set.

hasUnmanagedDatasetConfig()

public abstract 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];

Returns
Type	Description
boolean	Whether the unmanagedDatasetConfig field is set.