Class: Google::Cloud::DiscoveryEngine::V1::PanelInfo

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::PanelInfo

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1/user_event.rb

Overview

Detailed panel information associated with a user event.

Instance Attribute Summary

• #display_name ⇒ ::String

  The display name of the panel.

• #panel_id ⇒ ::String

  Required.

• #panel_position ⇒ ::Integer

  The ordered position of the panel, if shown to the user with other panels.

• #total_panels ⇒ ::Integer

  The total number of panels, including this one, shown to the user.

Instance Attribute Details

#display_name ⇒ ::String

Returns The display name of the panel.

Returns:

• (::String) —

  The display name of the panel.

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 478

class PanelInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#panel_id ⇒ ::String

Returns Required. The panel ID.

Returns:

• (::String) —

  Required. The panel ID.

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 478

class PanelInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#panel_position ⇒ ::Integer

Returns The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.

Returns:

• (::Integer) —

  The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 478

class PanelInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#total_panels ⇒ ::Integer

Returns The total number of panels, including this one, shown to the user. Must be set if panel_position is set.

Returns:

• (::Integer) —

  The total number of panels, including this one, shown to the user. Must be set if panel_position is set.

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 478

class PanelInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end