Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField

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

Facet field that maps to a UI Component.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField

Returns a new instance of GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField.



5320
5321
5322
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5320

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

Instance Attribute Details

#device_visibility ⇒ Array<String>

The field visibility on different types of devices. Corresponds to the JSON property deviceVisibility

Returns:

  • (Array<String>) 


5307
5308
5309
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5307

def device_visibility
  @device_visibility
end

#display_template ⇒ String

The template to customize how the field is displayed. An example value would be a string that looks like: "Price: value". Corresponds to the JSON property displayTemplate

Returns:

  • (String) 


5313
5314
5315
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5313

def display_template
  @display_template
end

#field ⇒ String

Required. Registered field name. The format is field.abc. Corresponds to the JSON property field

Returns:

  • (String) 


5318
5319
5320
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5318

def field
  @field
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5325
5326
5327
5328
5329
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5325

def update!(**args)
  @device_visibility = args[:device_visibility] if args.key?(:device_visibility)
  @display_template = args[:display_template] if args.key?(:display_template)
  @field = args[:field] if args.key?(:field)
end