Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

UI component configuration for data store.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig

Returns a new instance of GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.



8475
8476
8477
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8475

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#facet_field ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField>

Facet fields that store the mapping of fields to end user widget appearance. Corresponds to the JSON property facetField

Returns:



8449
8450
8451
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8449

def facet_field
  @facet_field
end

#fields_ui_components_map ⇒ Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField>

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. Corresponds to the JSON property fieldsUiComponentsMap

Returns:



8458
8459
8460
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8458

def fields_ui_components_map
  @fields_ui_components_map
end

#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. Corresponds to the JSON property id

Returns:

  • (String) 


8465
8466
8467
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8465

def id
  @id
end

#name ⇒ String

The name of the data store. It should be data store resource name Format: projects/project_number/locations/location/collections/collection_id/ dataStores/data_store_id`. For widget service usage, such look up widget config, returned name should be skipped. Corresponds to the JSON propertyname`

Returns:

  • (String) 


8473
8474
8475
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8473

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8480
8481
8482
8483
8484
8485
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8480

def update!(**args)
  @facet_field = args[:facet_field] if args.key?(:facet_field)
  @fields_ui_components_map = args[:fields_ui_components_map] if args.key?(:fields_ui_components_map)
  @id = args[:id] if args.key?(:id)
  @name = args[:name] if args.key?(:name)
end