Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::PanelInfo (v0.21.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::PanelInfo.

Detailed panel information associated with a user event.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#display_name

def display_name() -> ::String
Returns
  • (::String) — The display name of the panel.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — The display name of the panel.
Returns
  • (::String) — The display name of the panel.

#documents

def documents() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::DocumentInfo>
Returns

#documents=

def documents=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::DocumentInfo>
Parameter
Returns

#panel_id

def panel_id() -> ::String
Returns
  • (::String) — Required. The panel ID.

#panel_id=

def panel_id=(value) -> ::String
Parameter
  • value (::String) — Required. The panel ID.
Returns
  • (::String) — Required. The panel ID.

#panel_position

def panel_position() -> ::Integer
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.

#panel_position=

def panel_position=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

#total_panels

def total_panels() -> ::Integer
Returns
  • (::Integer) — The total number of panels, including this one, shown to the user. Must be set if panel_position is set.

#total_panels=

def total_panels=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.