Document AI V1beta3 API - Class Google::Cloud::DocumentAI::V1beta3::Dataset (v0.39.0)

Version latest

• 0.39.0 (latest)
• 0.38.0
• 0.37.0
• 0.36.1
• 0.35.0
• 0.34.0
• 0.33.1
• 0.32.0
• 0.31.0
• 0.30.2
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.4

Reference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::Dataset.

A singleton resource under a Processor which configures a collection of documents.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#document_warehouse_config

def document_warehouse_config() -> ::Google::Cloud::DocumentAI::V1beta3::Dataset::DocumentWarehouseConfig

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Dataset::DocumentWarehouseConfig) — Optional. Deprecated. Warehouse-based dataset configuration is not supported.

  Note: The following fields are mutually exclusive: document_warehouse_config, gcs_managed_config, unmanaged_dataset_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#document_warehouse_config=

def document_warehouse_config=(value) -> ::Google::Cloud::DocumentAI::V1beta3::Dataset::DocumentWarehouseConfig

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::Dataset::DocumentWarehouseConfig) — Optional. Deprecated. Warehouse-based dataset configuration is not supported.

  Note: The following fields are mutually exclusive: document_warehouse_config, gcs_managed_config, unmanaged_dataset_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Dataset::DocumentWarehouseConfig) — Optional. Deprecated. Warehouse-based dataset configuration is not supported.

  Note: The following fields are mutually exclusive: document_warehouse_config, gcs_managed_config, unmanaged_dataset_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs_managed_config

def gcs_managed_config() -> ::Google::Cloud::DocumentAI::V1beta3::Dataset::GCSManagedConfig

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Dataset::GCSManagedConfig) — Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location.

  Note: The following fields are mutually exclusive: gcs_managed_config, document_warehouse_config, unmanaged_dataset_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs_managed_config=

def gcs_managed_config=(value) -> ::Google::Cloud::DocumentAI::V1beta3::Dataset::GCSManagedConfig

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::Dataset::GCSManagedConfig) — Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location.

  Note: The following fields are mutually exclusive: gcs_managed_config, document_warehouse_config, unmanaged_dataset_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Dataset::GCSManagedConfig) — Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location.

  Note: The following fields are mutually exclusive: gcs_managed_config, document_warehouse_config, unmanaged_dataset_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#name

def name() -> ::String

Returns

• (::String) — Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

Returns

• (::String) — Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

#satisfies_pzi

def satisfies_pzi() -> ::Boolean

Returns

• (::Boolean) — Output only. Reserved for future use.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean

Returns

• (::Boolean) — Output only. Reserved for future use.

#spanner_indexing_config

def spanner_indexing_config() -> ::Google::Cloud::DocumentAI::V1beta3::Dataset::SpannerIndexingConfig

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Dataset::SpannerIndexingConfig) — Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search.

#spanner_indexing_config=

def spanner_indexing_config=(value) -> ::Google::Cloud::DocumentAI::V1beta3::Dataset::SpannerIndexingConfig

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::Dataset::SpannerIndexingConfig) — Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search.

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Dataset::SpannerIndexingConfig) — Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search.

#state

def state() -> ::Google::Cloud::DocumentAI::V1beta3::Dataset::State

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Dataset::State) — Required. State of the dataset. Ignored when updating dataset.

#state=

def state=(value) -> ::Google::Cloud::DocumentAI::V1beta3::Dataset::State

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::Dataset::State) — Required. State of the dataset. Ignored when updating dataset.

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Dataset::State) — Required. State of the dataset. Ignored when updating dataset.

#unmanaged_dataset_config

def unmanaged_dataset_config() -> ::Google::Cloud::DocumentAI::V1beta3::Dataset::UnmanagedDatasetConfig

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Dataset::UnmanagedDatasetConfig) — Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed).

  Note: The following fields are mutually exclusive: unmanaged_dataset_config, gcs_managed_config, document_warehouse_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#unmanaged_dataset_config=

def unmanaged_dataset_config=(value) -> ::Google::Cloud::DocumentAI::V1beta3::Dataset::UnmanagedDatasetConfig

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::Dataset::UnmanagedDatasetConfig) — Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed).

  Note: The following fields are mutually exclusive: unmanaged_dataset_config, gcs_managed_config, document_warehouse_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Dataset::UnmanagedDatasetConfig) — Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed).

  Note: The following fields are mutually exclusive: unmanaged_dataset_config, gcs_managed_config, document_warehouse_config. If a field in that set is populated, all other fields in the set will automatically be cleared.