Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPanelInfo
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPanelInfo
- 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
Detailed panel information associated with a user event.
Instance Attribute Summary collapse
-
#display_name ⇒ String
The display name of the panel.
-
#panel_id ⇒ String
Required.
-
#panel_position ⇒ Fixnum
The ordered position of the panel, if shown to the user with other panels.
-
#total_panels ⇒ Fixnum
The total number of panels, including this one, shown to the user.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaPanelInfo
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaPanelInfo.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaPanelInfo
Returns a new instance of GoogleCloudDiscoveryengineV1alphaPanelInfo.
1298 1299 1300 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1298 def initialize(**args) update!(**args) end |
Instance Attribute Details
#display_name ⇒ String
The display name of the panel.
Corresponds to the JSON property displayName
1279 1280 1281 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1279 def display_name @display_name end |
#panel_id ⇒ String
Required. The panel ID.
Corresponds to the JSON property panelId
1284 1285 1286 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1284 def panel_id @panel_id end |
#panel_position ⇒ Fixnum
The ordered position of the panel, if shown to the user with other panels. If
set, then total_panels must also be set.
Corresponds to the JSON property panelPosition
1290 1291 1292 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1290 def panel_position @panel_position end |
#total_panels ⇒ Fixnum
The total number of panels, including this one, shown to the user. Must be set
if panel_position is set.
Corresponds to the JSON property totalPanels
1296 1297 1298 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1296 def total_panels @total_panels end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1303 1304 1305 1306 1307 1308 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1303 def update!(**args) @display_name = args[:display_name] if args.key?(:display_name) @panel_id = args[:panel_id] if args.key?(:panel_id) @panel_position = args[:panel_position] if args.key?(:panel_position) @total_panels = args[:total_panels] if args.key?(:total_panels) end |