Google Cloud Discovery Engine V1 Client - Class DataStore (1.6.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class DataStore.

DataStore captures global settings and configs at the DataStore level.

Generated from protobuf message google.cloud.discoveryengine.v1.DataStore

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name 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.
↳ display_name 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.
↳ industry_vertical int

Immutable. The industry vertical that the data store registers.
↳ solution_types array

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 string

Output only. The id of the default Schema associated to this data store.
↳ content_config int

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

Output only. Timestamp the DataStore was created at.
↳ advanced_site_search_config AdvancedSiteSearchConfig

Optional. Configuration for advanced site search.
↳ kms_key_name 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.
↳ cmek_config CmekConfig

Output only. CMEK-related information for the DataStore.
↳ billing_estimation 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 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 DocumentProcessingConfig

Configuration for Document understanding and enrichment.
↳ starting_schema 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 HealthcareFhirConfig

Optional. Configuration for HEALTHCARE_FHIR vertical.
↳ 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_PARTY or GSUITE IdP. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.

getName

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
Type Description
string

setName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

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
Type Description
string

setDisplayName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getIndustryVertical

Immutable. The industry vertical that the data store registers.

Returns
Type Description
int

setIndustryVertical

Immutable. The industry vertical that the data store registers.

Parameter
Name Description
var int
Returns
Type Description
$this

getSolutionTypes

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
Type Description
Google\Protobuf\Internal\RepeatedField

setSolutionTypes

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.

Parameter
Name Description
var int[]
Returns
Type Description
$this

getDefaultSchemaId

Output only. The id of the default Schema associated to this data store.

Returns
Type Description
string

setDefaultSchemaId

Output only. The id of the default Schema associated to this data store.

Parameter
Name Description
var string
Returns
Type Description
$this

getContentConfig

Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.

Returns
Type Description
int

setContentConfig

Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.

Parameter
Name Description
var int
Returns
Type Description
$this

getCreateTime

Output only. Timestamp the DataStore was created at.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp the DataStore was created at.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getAdvancedSiteSearchConfig

Optional. Configuration for advanced site search.

Returns
Type Description
AdvancedSiteSearchConfig|null

hasAdvancedSiteSearchConfig

clearAdvancedSiteSearchConfig

setAdvancedSiteSearchConfig

Optional. Configuration for advanced site search.

Parameter
Name Description
var AdvancedSiteSearchConfig
Returns
Type Description
$this

getKmsKeyName

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
Type Description
string

setKmsKeyName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getCmekConfig

Output only. CMEK-related information for the DataStore.

Returns
Type Description
CmekConfig|null

hasCmekConfig

clearCmekConfig

setCmekConfig

Output only. CMEK-related information for the DataStore.

Parameter
Name Description
var CmekConfig
Returns
Type Description
$this

getBillingEstimation

Output only. Data size estimation for billing.

Returns
Type Description
DataStore\BillingEstimation|null

hasBillingEstimation

clearBillingEstimation

setBillingEstimation

Output only. Data size estimation for billing.

Parameter
Name Description
var DataStore\BillingEstimation
Returns
Type Description
$this

getAclEnabled

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
Type Description
bool

setAclEnabled

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getWorkspaceConfig

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
Type Description
WorkspaceConfig|null

hasWorkspaceConfig

clearWorkspaceConfig

setWorkspaceConfig

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.

Parameter
Name Description
var WorkspaceConfig
Returns
Type Description
$this

getDocumentProcessingConfig

Configuration for Document understanding and enrichment.

Returns
Type Description
DocumentProcessingConfig|null

hasDocumentProcessingConfig

clearDocumentProcessingConfig

setDocumentProcessingConfig

Configuration for Document understanding and enrichment.

Parameter
Name Description
var DocumentProcessingConfig
Returns
Type Description
$this

getStartingSchema

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
Type Description
Schema|null

hasStartingSchema

clearStartingSchema

setStartingSchema

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.

Parameter
Name Description
var Schema
Returns
Type Description
$this

getHealthcareFhirConfig

Optional. Configuration for HEALTHCARE_FHIR vertical.

Returns
Type Description
HealthcareFhirConfig|null

hasHealthcareFhirConfig

clearHealthcareFhirConfig

setHealthcareFhirConfig

Optional. Configuration for HEALTHCARE_FHIR vertical.

Parameter
Name Description
var HealthcareFhirConfig
Returns
Type Description
$this

getIdentityMappingStore

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
Type Description
string

setIdentityMappingStore

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}.

Parameter
Name Description
var string
Returns
Type Description
$this