View Source GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaDataStore (google_api_discovery_engine v0.22.0)
DataStore captures global settings and configs at the DataStore level.
Attributes
-
aclEnabled
(type:boolean()
, default:nil
) - Immutable. Whether data in the DataStore has ACL information. If set totrue
, 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 inGENERIC
industry vertical with non-PUBLIC_WEBSITE
content config. -
advancedSiteSearchConfig
(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig.t
, default:nil
) - Optional. Configuration for advanced site search. -
billingEstimation
(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation.t
, default:nil
) - Output only. Data size estimation for billing. -
cmekConfig
(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaCmekConfig.t
, default:nil
) - Output only. CMEK-related information for the DataStore. -
contentConfig
(type:String.t
, default:nil
) - Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. -
createTime
(type:DateTime.t
, default:nil
) - Output only. Timestamp the DataStore was created at. -
defaultSchemaId
(type:String.t
, default:nil
) - Output only. The id of the default Schema asscociated to this data store. -
displayName
(type:String.t
, default:nil
) - 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. -
documentProcessingConfig
(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.t
, default:nil
) - Configuration for Document understanding and enrichment. -
idpConfig
(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaIdpConfig.t
, default:nil
) - Output only. Data store level identity provider config. -
industryVertical
(type:String.t
, default:nil
) - Immutable. The industry vertical that the data store registers. -
kmsKeyName
(type:String.t
, default:nil
) - 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. -
languageInfo
(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaLanguageInfo.t
, default:nil
) - Language info for DataStore. -
name
(type:String.t
, default:nil
) - Immutable. 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. -
naturalLanguageQueryUnderstandingConfig
(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig.t
, default:nil
) - Optional. Configuration for Natural Language Query Understanding. -
servingConfigDataStore
(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore.t
, default:nil
) - Optional. Stores serving config at DataStore level. -
solutionTypes
(type:list(String.t)
, default:nil
) - The solutions that the data store enrolls. Available solutions for each industry_vertical:MEDIA
:SOLUTION_TYPE_RECOMMENDATION
andSOLUTION_TYPE_SEARCH
.SITE_SEARCH
:SOLUTION_TYPE_SEARCH
is automatically enrolled. Other solutions cannot be enrolled. -
startingSchema
(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaSchema.t
, default:nil
) - 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. -
workspaceConfig
(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaWorkspaceConfig.t
, default:nil
) - 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.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaDataStore{ aclEnabled: boolean() | nil, advancedSiteSearchConfig: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig.t() | nil, billingEstimation: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation.t() | nil, cmekConfig: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaCmekConfig.t() | nil, contentConfig: String.t() | nil, createTime: DateTime.t() | nil, defaultSchemaId: String.t() | nil, displayName: String.t() | nil, documentProcessingConfig: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.t() | nil, idpConfig: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaIdpConfig.t() | nil, industryVertical: String.t() | nil, kmsKeyName: String.t() | nil, languageInfo: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaLanguageInfo.t() | nil, name: String.t() | nil, naturalLanguageQueryUnderstandingConfig: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig.t() | nil, servingConfigDataStore: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore.t() | nil, solutionTypes: [String.t()] | nil, startingSchema: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaSchema.t() | nil, workspaceConfig: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaWorkspaceConfig.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.