public sealed class DataStore : IMessage<DataStore>, IEquatable<DataStore>, IDeepCloneable<DataStore>, IBufferMessage, IMessageReference documentation and code samples for the Discovery Engine v1 API class DataStore.
DataStore captures global settings and configs at the DataStore level.
Implements
IMessageDataStore, IEquatableDataStore, IDeepCloneableDataStore, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
DataStore()
public DataStore()DataStore(DataStore)
public DataStore(DataStore other)| Parameter | |
|---|---|
| Name | Description |
other |
DataStore |
Properties
AclEnabled
public bool AclEnabled { get; set; }Immutable. Whether data in the
[DataStore][google.cloud.discoveryengine.v1.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][google.cloud.discoveryengine.v1.DocumentService.ImportDocuments]
methods.
When ACL is enabled for the [DataStore][google.cloud.discoveryengine.v1.DataStore], [Document][google.cloud.discoveryengine.v1.Document] can't be accessed by calling [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] or [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments].
Currently ACL is only supported in GENERIC industry vertical with
non-PUBLIC_WEBSITE content config.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
AdvancedSiteSearchConfig
public AdvancedSiteSearchConfig AdvancedSiteSearchConfig { get; set; }Optional. Configuration for advanced site search.
| Property Value | |
|---|---|
| Type | Description |
AdvancedSiteSearchConfig |
|
BillingEstimation
public DataStore.Types.BillingEstimation BillingEstimation { get; set; }Output only. Data size estimation for billing.
| Property Value | |
|---|---|
| Type | Description |
DataStoreTypesBillingEstimation |
|
CmekConfig
public CmekConfig CmekConfig { get; set; }Output only. CMEK-related information for the DataStore.
| Property Value | |
|---|---|
| Type | Description |
CmekConfig |
|
ContentConfig
public DataStore.Types.ContentConfig ContentConfig { get; set; }Immutable. The content config of the data store. If this field is unset, the server behavior defaults to [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1.DataStore.ContentConfig.NO_CONTENT].
| Property Value | |
|---|---|
| Type | Description |
DataStoreTypesContentConfig |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. Timestamp the [DataStore][google.cloud.discoveryengine.v1.DataStore] was created at.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
DataStoreName
public DataStoreName DataStoreName { get; set; }DataStoreName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
DataStoreName |
|
DefaultSchemaId
public string DefaultSchemaId { get; set; }Output only. The id of the default [Schema][google.cloud.discoveryengine.v1.Schema] associated to this data store.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DisplayName
public string DisplayName { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DocumentProcessingConfig
public DocumentProcessingConfig DocumentProcessingConfig { get; set; }Configuration for Document understanding and enrichment.
| Property Value | |
|---|---|
| Type | Description |
DocumentProcessingConfig |
|
HealthcareFhirConfig
public HealthcareFhirConfig HealthcareFhirConfig { get; set; }Optional. Configuration for HEALTHCARE_FHIR vertical.
| Property Value | |
|---|---|
| Type | Description |
HealthcareFhirConfig |
|
IdentityMappingStore
public string IdentityMappingStore { get; set; }Immutable. The fully qualified resource name of the associated
[IdentityMappingStore][google.cloud.discoveryengine.v1.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}.
| Property Value | |
|---|---|
| Type | Description |
string |
|
IdentityMappingStoreAsIdentityMappingStoreName
public IdentityMappingStoreName IdentityMappingStoreAsIdentityMappingStoreName { get; set; }IdentityMappingStoreName-typed view over the IdentityMappingStore resource name property.
| Property Value | |
|---|---|
| Type | Description |
IdentityMappingStoreName |
|
IndustryVertical
public IndustryVertical IndustryVertical { get; set; }Immutable. The industry vertical that the data store registers.
| Property Value | |
|---|---|
| Type | Description |
IndustryVertical |
|
KmsKeyName
public string KmsKeyName { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Name
public string Name { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SolutionTypes
public RepeatedField<SolutionType> SolutionTypes { get; }The solutions that the data store enrolls. Available solutions for each [industry_vertical][google.cloud.discoveryengine.v1.DataStore.industry_vertical]:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldSolutionType |
|
StartingSchema
public Schema StartingSchema { get; set; }The start schema to use for this [DataStore][google.cloud.discoveryengine.v1.DataStore] when provisioning it. If unset, a default vertical specialized schema will be used.
This field is only used by [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] API, and will be ignored if used in other APIs. This field will be omitted from all API responses including [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] API. To retrieve a schema of a [DataStore][google.cloud.discoveryengine.v1.DataStore], use [SchemaService.GetSchema][google.cloud.discoveryengine.v1.SchemaService.GetSchema] API instead.
The provided schema will be validated against certain rules on schema. Learn more from this doc.
| Property Value | |
|---|---|
| Type | Description |
Schema |
|
WorkspaceConfig
public WorkspaceConfig WorkspaceConfig { get; set; }Config to store data store type configuration for workspace data. This must be set when [DataStore.content_config][google.cloud.discoveryengine.v1.DataStore.content_config] is set as [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1.DataStore.ContentConfig.GOOGLE_WORKSPACE].
| Property Value | |
|---|---|
| Type | Description |
WorkspaceConfig |
|