Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class DataStoreUiConfig (0.20.6)

DataStoreUiConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

UI component configuration for data store.

Attributes
Name	Description
`name`	`str` 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, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field.
`id`	`str` 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.
`facet_field`	`MutableSequence[google.cloud.discoveryengine_v1.types.WidgetConfig.FacetField]` Facet fields that store the mapping of fields to end user widget appearance.
`fields_ui_components_map`	`MutableMapping[str, google.cloud.discoveryengine_v1.types.WidgetConfig.UIComponentField]` 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.

Classes

FieldsUiComponentsMapEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.