DataStore(mapping=None, *, ignore_unknown_fields=False, **kwargs)DataStore captures global settings and configs at the DataStore level.
Attributes |
|
|---|---|
| Name | Description |
name |
str
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.
|
display_name |
str
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. |
industry_vertical |
google.cloud.discoveryengine_v1beta.types.IndustryVertical
Immutable. The industry vertical that the data store registers. |
solution_types |
MutableSequence[google.cloud.discoveryengine_v1beta.types.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.
|
default_schema_id |
str
Output only. The id of the default Schema associated to this data store. |
content_config |
google.cloud.discoveryengine_v1beta.types.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 |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp the DataStore was created at. |
advanced_site_search_config |
google.cloud.discoveryengine_v1beta.types.AdvancedSiteSearchConfig
Optional. Configuration for advanced site search. |
language_info |
google.cloud.discoveryengine_v1beta.types.LanguageInfo
Language info for DataStore. |
natural_language_query_understanding_config |
google.cloud.discoveryengine_v1beta.types.NaturalLanguageQueryUnderstandingConfig
Optional. Configuration for Natural Language Query Understanding. |
kms_key_name |
str
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. |
cmek_config |
google.cloud.discoveryengine_v1beta.types.CmekConfig
Output only. CMEK-related information for the DataStore. |
billing_estimation |
google.cloud.discoveryengine_v1beta.types.DataStore.BillingEstimation
Output only. Data size estimation for billing. |
acl_enabled |
bool
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.
|
workspace_config |
google.cloud.discoveryengine_v1beta.types.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. |
document_processing_config |
google.cloud.discoveryengine_v1beta.types.DocumentProcessingConfig
Configuration for Document understanding and enrichment. |
starting_schema |
google.cloud.discoveryengine_v1beta.types.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 |
healthcare_fhir_config |
google.cloud.discoveryengine_v1beta.types.HealthcareFhirConfig
Optional. Configuration for HEALTHCARE_FHIR vertical.
|
serving_config_data_store |
google.cloud.discoveryengine_v1beta.types.DataStore.ServingConfigDataStore
Optional. Stores serving config at DataStore level. |
identity_mapping_store |
str
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}.
|
is_infobot_faq_data_store |
bool
Optional. If set, this DataStore is an Infobot FAQ DataStore. |
federated_search_config |
google.cloud.discoveryengine_v1beta.types.DataStore.FederatedSearchConfig
Optional. If set, this DataStore is a federated search DataStore. |
configurable_billing_approach |
google.cloud.discoveryengine_v1beta.types.DataStore.ConfigurableBillingApproach
Optional. Configuration for configurable billing approach. See |
configurable_billing_approach_update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp when configurable_billing_approach was last updated. |
Classes
BillingEstimation
BillingEstimation(mapping=None, *, ignore_unknown_fields=False, **kwargs)Estimation of data size per data store.
ConfigurableBillingApproach
ConfigurableBillingApproach(value)Configuration for configurable billing approach.
ContentConfig
ContentConfig(value)Content config of the data store.
FederatedSearchConfig
FederatedSearchConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)Stores information for federated search.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ServingConfigDataStore
ServingConfigDataStore(mapping=None, *, ignore_unknown_fields=False, **kwargs)Stores information regarding the serving configurations at DataStore level.