Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPanelInfo

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

Detailed panel information associated with a user event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaPanelInfo

Returns a new instance of GoogleCloudDiscoveryengineV1alphaPanelInfo.



1143
1144
1145
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1143

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

Instance Attribute Details

#display_nameString

The display name of the panel. Corresponds to the JSON property displayName

Returns:

  • (String)


1124
1125
1126
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1124

def display_name
  @display_name
end

#panel_idString

Required. The panel ID. Corresponds to the JSON property panelId

Returns:

  • (String)


1129
1130
1131
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1129

def panel_id
  @panel_id
end

#panel_positionFixnum

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

Returns:

  • (Fixnum)


1135
1136
1137
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1135

def panel_position
  @panel_position
end

#total_panelsFixnum

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

Returns:

  • (Fixnum)


1141
1142
1143
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1141

def total_panels
  @total_panels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1148
1149
1150
1151
1152
1153
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1148

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