Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::DataStore (v0.28.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::DataStore.

DataStore captures global settings and configs at the DataStore level.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#acl_enabled

def acl_enabled() -> ::Boolean

Returns

(::Boolean) — Immutable. Whether data in the DataStore has ACL information. If set to true, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods.

When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments.

Currently ACL is only supported in GENERIC industry vertical with non-PUBLIC_WEBSITE content config.

#acl_enabled=

def acl_enabled=(value) -> ::Boolean

Parameter

value (::Boolean) — Immutable. Whether data in the DataStore has ACL information. If set to true, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods.

When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments.

Currently ACL is only supported in GENERIC industry vertical with non-PUBLIC_WEBSITE content config.

Returns

(::Boolean) — Immutable. Whether data in the DataStore has ACL information. If set to true, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods.

When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments.

Currently ACL is only supported in GENERIC industry vertical with non-PUBLIC_WEBSITE content config.

#advanced_site_search_config

def advanced_site_search_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::AdvancedSiteSearchConfig

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::AdvancedSiteSearchConfig) — Optional. Configuration for advanced site search.

#advanced_site_search_config=

def advanced_site_search_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::AdvancedSiteSearchConfig

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::AdvancedSiteSearchConfig) — Optional. Configuration for advanced site search.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::AdvancedSiteSearchConfig) — Optional. Configuration for advanced site search.

#billing_estimation

def billing_estimation() -> ::Google::Cloud::DiscoveryEngine::V1beta::DataStore::BillingEstimation

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::DataStore::BillingEstimation) — Output only. Data size estimation for billing.

#cmek_config

def cmek_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig) — Output only. CMEK-related information for the DataStore.

#configurable_billing_approach

def configurable_billing_approach() -> ::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ConfigurableBillingApproach

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ConfigurableBillingApproach) — Optional. Configuration for configurable billing approach. See

#configurable_billing_approach=

def configurable_billing_approach=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ConfigurableBillingApproach

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ConfigurableBillingApproach) — Optional. Configuration for configurable billing approach. See

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ConfigurableBillingApproach) — Optional. Configuration for configurable billing approach. See

#configurable_billing_approach_update_time

def configurable_billing_approach_update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The timestamp when configurable_billing_approach was last updated.

#content_config

def content_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ContentConfig

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ContentConfig) — Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.

#content_config=

def content_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ContentConfig

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ContentConfig) — Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ContentConfig) — Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Timestamp the DataStore was created at.

#default_schema_id

def default_schema_id() -> ::String

Returns

(::String) — Output only. The id of the default Schema associated to this data store.

#display_name

def display_name() -> ::String

Returns

(::String) — Required. The data store display name.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — Required. The data store display name.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Returns

(::String) — Required. The data store display name.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

#document_processing_config

def document_processing_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig) — Configuration for Document understanding and enrichment.

#document_processing_config=

def document_processing_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig) — Configuration for Document understanding and enrichment.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig) — Configuration for Document understanding and enrichment.

#federated_search_config

def federated_search_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::DataStore::FederatedSearchConfig

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::DataStore::FederatedSearchConfig) — Optional. If set, this DataStore is a federated search DataStore.

#federated_search_config=

def federated_search_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::DataStore::FederatedSearchConfig

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::DataStore::FederatedSearchConfig) — Optional. If set, this DataStore is a federated search DataStore.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::DataStore::FederatedSearchConfig) — Optional. If set, this DataStore is a federated search DataStore.

#healthcare_fhir_config

def healthcare_fhir_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::HealthcareFhirConfig

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::HealthcareFhirConfig) — Optional. Configuration for HEALTHCARE_FHIR vertical.

#healthcare_fhir_config=

def healthcare_fhir_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::HealthcareFhirConfig

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::HealthcareFhirConfig) — Optional. Configuration for HEALTHCARE_FHIR vertical.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::HealthcareFhirConfig) — Optional. Configuration for HEALTHCARE_FHIR vertical.

#identity_mapping_store

def identity_mapping_store() -> ::String

Returns

(::String) — Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with THIRD_PARTY or GSUITE IdP. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.

#identity_mapping_store=

def identity_mapping_store=(value) -> ::String

Parameter

value (::String) — Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with THIRD_PARTY or GSUITE IdP. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.

Returns

(::String) — Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with THIRD_PARTY or GSUITE IdP. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.

#industry_vertical

def industry_vertical() -> ::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical) — Immutable. The industry vertical that the data store registers.

#industry_vertical=

def industry_vertical=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical) — Immutable. The industry vertical that the data store registers.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical) — Immutable. The industry vertical that the data store registers.

#is_infobot_faq_data_store

def is_infobot_faq_data_store() -> ::Boolean

Returns

(::Boolean) — Optional. If set, this DataStore is an Infobot FAQ DataStore.

#is_infobot_faq_data_store=

def is_infobot_faq_data_store=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. If set, this DataStore is an Infobot FAQ DataStore.

Returns

(::Boolean) — Optional. If set, this DataStore is an Infobot FAQ DataStore.

#kms_key_name

def kms_key_name() -> ::String

Returns

(::String) — Input only. The KMS key to be used to protect this DataStore at creation time.

Must be set for requests that need to comply with CMEK Org Policy protections.

If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.

#kms_key_name=

def kms_key_name=(value) -> ::String

Parameter

value (::String) — Input only. The KMS key to be used to protect this DataStore at creation time.

Must be set for requests that need to comply with CMEK Org Policy protections.

If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.

Returns

(::String) — Input only. The KMS key to be used to protect this DataStore at creation time.

Must be set for requests that need to comply with CMEK Org Policy protections.

If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.

#language_info

def language_info() -> ::Google::Cloud::DiscoveryEngine::V1beta::LanguageInfo

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::LanguageInfo) — Language info for DataStore.

#language_info=

def language_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::LanguageInfo

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::LanguageInfo) — Language info for DataStore.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::LanguageInfo) — Language info for DataStore.

#name

def name() -> ::String

Returns

(::String) — Immutable. Identifier. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Immutable. Identifier. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Returns

(::String) — Immutable. Identifier. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

#natural_language_query_understanding_config

def natural_language_query_understanding_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::NaturalLanguageQueryUnderstandingConfig

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::NaturalLanguageQueryUnderstandingConfig) — Optional. Configuration for Natural Language Query Understanding.

#natural_language_query_understanding_config=

def natural_language_query_understanding_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::NaturalLanguageQueryUnderstandingConfig

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::NaturalLanguageQueryUnderstandingConfig) — Optional. Configuration for Natural Language Query Understanding.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::NaturalLanguageQueryUnderstandingConfig) — Optional. Configuration for Natural Language Query Understanding.

#serving_config_data_store

def serving_config_data_store() -> ::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ServingConfigDataStore

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ServingConfigDataStore) — Optional. Stores serving config at DataStore level.

#serving_config_data_store=

def serving_config_data_store=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ServingConfigDataStore

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ServingConfigDataStore) — Optional. Stores serving config at DataStore level.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ServingConfigDataStore) — Optional. Stores serving config at DataStore level.

#solution_types

def solution_types() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SolutionType>

Returns

(::Array<::Google::Cloud::DiscoveryEngine::V1beta::SolutionType>) —
The solutions that the data store enrolls. Available solutions for each industry_vertical:
- MEDIA: SOLUTION_TYPE_RECOMMENDATION and SOLUTION_TYPE_SEARCH.
- SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.

#solution_types=

def solution_types=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SolutionType>

Parameter

value (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SolutionType>) —
The solutions that the data store enrolls. Available solutions for each industry_vertical:
- MEDIA: SOLUTION_TYPE_RECOMMENDATION and SOLUTION_TYPE_SEARCH.
- SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.

Returns

(::Array<::Google::Cloud::DiscoveryEngine::V1beta::SolutionType>) —
The solutions that the data store enrolls. Available solutions for each industry_vertical:
- MEDIA: SOLUTION_TYPE_RECOMMENDATION and SOLUTION_TYPE_SEARCH.
- SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.

#starting_schema

def starting_schema() -> ::Google::Cloud::DiscoveryEngine::V1beta::Schema

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::Schema) — The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.

This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.

The provided schema will be validated against certain rules on schema. Learn more from this doc.

#starting_schema=

def starting_schema=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Schema

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::Schema) — The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.

This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.

The provided schema will be validated against certain rules on schema. Learn more from this doc.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::Schema) — The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.

This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.

The provided schema will be validated against certain rules on schema. Learn more from this doc.

#workspace_config

def workspace_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::WorkspaceConfig

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::WorkspaceConfig) — Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.

#workspace_config=

def workspace_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::WorkspaceConfig

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::WorkspaceConfig) — Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::WorkspaceConfig) — Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.