Discovery Engine v1 API - Class DataStore (1.3.0)

public sealed class DataStore : IMessage<DataStore>, IEquatable<DataStore>, IDeepCloneable<DataStore>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class DataStore.

DataStore captures global settings and configs at the DataStore level.

Inheritance

object > DataStore

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

DataStore()

public DataStore()

DataStore(DataStore)

public DataStore(DataStore other)
Parameter
Name Description
other DataStore

Properties

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] asscociated 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

IndustryVertical

public IndustryVertical IndustryVertical { get; set; }

Immutable. The industry vertical that the data store registers.

Property Value
Type Description
IndustryVertical

Name

public string Name { get; set; }

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.

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_RECOMMENDATION and SOLUTION_TYPE_SEARCH.
  • SITE_SEARCH: SOLUTION_TYPE_SEARCH is 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][] 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][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