Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::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-
(::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
GENERICindustry vertical with non-PUBLIC_WEBSITEcontent config.
#acl_enabled=
def acl_enabled=(value) -> ::Boolean-
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
GENERICindustry vertical with non-PUBLIC_WEBSITEcontent config.
-
(::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
GENERICindustry vertical with non-PUBLIC_WEBSITEcontent config.
#advanced_site_search_config
def advanced_site_search_config() -> ::Google::Cloud::DiscoveryEngine::V1::AdvancedSiteSearchConfig- (::Google::Cloud::DiscoveryEngine::V1::AdvancedSiteSearchConfig) — Optional. Configuration for advanced site search.
#advanced_site_search_config=
def advanced_site_search_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::AdvancedSiteSearchConfig- value (::Google::Cloud::DiscoveryEngine::V1::AdvancedSiteSearchConfig) — Optional. Configuration for advanced site search.
- (::Google::Cloud::DiscoveryEngine::V1::AdvancedSiteSearchConfig) — Optional. Configuration for advanced site search.
#billing_estimation
def billing_estimation() -> ::Google::Cloud::DiscoveryEngine::V1::DataStore::BillingEstimation- (::Google::Cloud::DiscoveryEngine::V1::DataStore::BillingEstimation) — Output only. Data size estimation for billing.
#cmek_config
def cmek_config() -> ::Google::Cloud::DiscoveryEngine::V1::CmekConfig- (::Google::Cloud::DiscoveryEngine::V1::CmekConfig) — Output only. CMEK-related information for the DataStore.
#content_config
def content_config() -> ::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig- (::Google::Cloud::DiscoveryEngine::V1::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::V1::DataStore::ContentConfig- value (::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig) — 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) — 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- (::Google::Protobuf::Timestamp) — Output only. Timestamp the DataStore was created at.
#default_schema_id
def default_schema_id() -> ::String- (::String) — Output only. The id of the default Schema associated to this data store.
#display_name
def display_name() -> ::String-
(::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-
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.
-
(::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::V1::DocumentProcessingConfig- (::Google::Cloud::DiscoveryEngine::V1::DocumentProcessingConfig) — Configuration for Document understanding and enrichment.
#document_processing_config=
def document_processing_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::DocumentProcessingConfig- value (::Google::Cloud::DiscoveryEngine::V1::DocumentProcessingConfig) — Configuration for Document understanding and enrichment.
- (::Google::Cloud::DiscoveryEngine::V1::DocumentProcessingConfig) — Configuration for Document understanding and enrichment.
#healthcare_fhir_config
def healthcare_fhir_config() -> ::Google::Cloud::DiscoveryEngine::V1::HealthcareFhirConfig-
(::Google::Cloud::DiscoveryEngine::V1::HealthcareFhirConfig) — Optional. Configuration for
HEALTHCARE_FHIRvertical.
#healthcare_fhir_config=
def healthcare_fhir_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::HealthcareFhirConfig-
value (::Google::Cloud::DiscoveryEngine::V1::HealthcareFhirConfig) — Optional. Configuration for
HEALTHCARE_FHIRvertical.
-
(::Google::Cloud::DiscoveryEngine::V1::HealthcareFhirConfig) — Optional. Configuration for
HEALTHCARE_FHIRvertical.
#identity_mapping_store
def identity_mapping_store() -> ::String-
(::String) — Immutable. The fully qualified resource name of the associated
IdentityMappingStore.
This field can only be set for acl_enabled DataStores with
THIRD_PARTYorGSUITEIdP. Format:projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
#identity_mapping_store=
def identity_mapping_store=(value) -> ::String-
value (::String) — Immutable. The fully qualified resource name of the associated
IdentityMappingStore.
This field can only be set for acl_enabled DataStores with
THIRD_PARTYorGSUITEIdP. Format:projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
-
(::String) — Immutable. The fully qualified resource name of the associated
IdentityMappingStore.
This field can only be set for acl_enabled DataStores with
THIRD_PARTYorGSUITEIdP. Format:projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
#industry_vertical
def industry_vertical() -> ::Google::Cloud::DiscoveryEngine::V1::IndustryVertical- (::Google::Cloud::DiscoveryEngine::V1::IndustryVertical) — Immutable. The industry vertical that the data store registers.
#industry_vertical=
def industry_vertical=(value) -> ::Google::Cloud::DiscoveryEngine::V1::IndustryVertical- value (::Google::Cloud::DiscoveryEngine::V1::IndustryVertical) — Immutable. The industry vertical that the data store registers.
- (::Google::Cloud::DiscoveryEngine::V1::IndustryVertical) — Immutable. The industry vertical that the data store registers.
#kms_key_name
def kms_key_name() -> ::String-
(::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-
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.
-
(::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.
#name
def name() -> ::String-
(::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-
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.
-
(::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.
#solution_types
def solution_types() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SolutionType>-
(::Array<::Google::Cloud::DiscoveryEngine::V1::SolutionType>) —
The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
#solution_types=
def solution_types=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SolutionType>-
value (::Array<::Google::Cloud::DiscoveryEngine::V1::SolutionType>) —
The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
-
(::Array<::Google::Cloud::DiscoveryEngine::V1::SolutionType>) —
The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
#starting_schema
def starting_schema() -> ::Google::Cloud::DiscoveryEngine::V1::Schema-
(::Google::Cloud::DiscoveryEngine::V1::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::V1::Schema-
value (::Google::Cloud::DiscoveryEngine::V1::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.
-
(::Google::Cloud::DiscoveryEngine::V1::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::V1::WorkspaceConfig- (::Google::Cloud::DiscoveryEngine::V1::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::V1::WorkspaceConfig- value (::Google::Cloud::DiscoveryEngine::V1::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.
- (::Google::Cloud::DiscoveryEngine::V1::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.