Google Cloud Discovery Engine V1 Client - Class DataStoreUiConfig (1.17.0)

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

UI component configuration for data store.

Generated from protobuf message google.cloud.discoveryengine.v1.WidgetConfig.DataStoreUiConfig

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfig

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

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 string

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 array<FacetField>

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

↳ fields_ui_components_map array|Google\Protobuf\Internal\MapField

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.

getName

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.

Returns
Type Description
string

setName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getId

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.

Returns
Type Description
string

setId

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getFacetField

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

Returns
Type Description
Google\Protobuf\RepeatedField<FacetField>

setFacetField

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

Parameter
Name Description
var array<FacetField>
Returns
Type Description
$this

getFieldsUiComponentsMap

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.

Returns
Type Description
Google\Protobuf\Internal\MapField

setFieldsUiComponentsMap

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.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this