Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::WidgetConfig::DataStoreUiConfig (v2.14.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::WidgetConfig::DataStoreUiConfig.

UI component configuration for data store.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#facet_field

def facet_field() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::FacetField>
Returns

#facet_field=

def facet_field=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::FacetField>
Parameter
Returns

#fields_ui_components_map

def fields_ui_components_map() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UIComponentField}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::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.

#fields_ui_components_map=

def fields_ui_components_map=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UIComponentField}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::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.

Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::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.

#id

def id() -> ::String
Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::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][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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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][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.
Returns
  • (::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][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.