Discovery Engine v1 API - Class WidgetConfig.Types.DataStoreUiConfig (1.17.0) 

public sealed class WidgetConfig.Types.DataStoreUiConfig : IMessage<WidgetConfig.Types.DataStoreUiConfig>, IEquatable<WidgetConfig.Types.DataStoreUiConfig>, IDeepCloneable<WidgetConfig.Types.DataStoreUiConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class WidgetConfig.Types.DataStoreUiConfig.

UI component configuration for data store.

Inheritance

object > WidgetConfig.Types.DataStoreUiConfig

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

DataStoreUiConfig()

public DataStoreUiConfig()

DataStoreUiConfig(DataStoreUiConfig)

public DataStoreUiConfig(WidgetConfig.Types.DataStoreUiConfig other)
Parameter
Name Description
other WidgetConfigTypesDataStoreUiConfig

Properties

FacetField

public RepeatedField<WidgetConfig.Types.FacetField> FacetField { get; }

Facet fields that store the mapping of fields to end user widget appearance.

Property Value
Type Description
RepeatedFieldWidgetConfigTypesFacetField

FieldsUiComponentsMap

public MapField<string, WidgetConfig.Types.UIComponentField> FieldsUiComponentsMap { get; }

The key is the UI component. Mock. Currently supported title, thumbnail, url, custom1, custom2, custom3.

The value is the name of the field along with its device visibility.

The 3 custom fields are optional and can be added or removed. title, thumbnail, url are required UI components that cannot be removed.

Property Value
Type Description
MapFieldstringWidgetConfigTypesUIComponentField

Id

public string Id { get; set; }

Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.

Property Value
Type Description
string

Name

public string Name { get; set; }

The name of the data store. It should be data store resource name Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. For APIs under [WidgetService][google.cloud.discoveryengine.v1.WidgetService], such as [WidgetService.LookupWidgetConfig][google.cloud.discoveryengine.v1.WidgetService.LookupWidgetConfig], the project number and location part is erased in this field.

Property Value
Type Description
string