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 \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
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.
↳ 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
↳ 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
↳ document_processing_config
Google\Cloud\DiscoveryEngine\V1\DocumentProcessingConfig
Configuration for Document understanding and enrichment.
↳ starting_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 .
getName
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.
string
setName
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.
var
string
$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.
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.
var
string
$this
getIndustryVertical
Immutable. The industry vertical that the data store registers.
int
setIndustryVertical
Immutable. The industry vertical that the data store registers.
var
int
$this
getSolutionTypes
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.
setSolutionTypes
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.
var
int[]
$this
getDefaultSchemaId
Output only. The id of the default Schema asscociated to this data store.
string
setDefaultSchemaId
Output only. The id of the default Schema asscociated to this data store.
var
string
$this
getContentConfig
Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT .
int
setContentConfig
Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT .
var
int
$this
getCreateTime
Output only. Timestamp the DataStore was created at.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp the DataStore was created at.
$this
getDocumentProcessingConfig
Configuration for Document understanding and enrichment.
hasDocumentProcessingConfig
clearDocumentProcessingConfig
setDocumentProcessingConfig
Configuration for Document understanding and enrichment.
$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 .
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 .
$this
