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

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

Read-only data store component that contains data stores fields that may be used for filtering, it's the child of CollectionComponent.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#data_store_config_type

def data_store_config_type() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::DataStoreComponent::DataStoreConfigType
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — The display name of the data store.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — The display name of the data store.
Returns
  • (::String) — The display name of the data store.

#entity_name

def entity_name() -> ::String
Returns
  • (::String) — The name of the entity, retrieved from Collection.data_connector.entities.entityName.

#entity_name=

def entity_name=(value) -> ::String
Parameter
  • value (::String) — The name of the entity, retrieved from Collection.data_connector.entities.entityName.
Returns
  • (::String) — The name of the entity, retrieved from Collection.data_connector.entities.entityName.

#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.