Google Cloud Discovery Engine V1 Client - Class PanelInfo (0.6.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class PanelInfo.

Detailed panel information associated with a user event.

Generated from protobuf message google.cloud.discoveryengine.v1.PanelInfo

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ panel_id string

Required. The panel ID.

↳ display_name string

The display name of the panel.

↳ panel_position int

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 int

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

getPanelId

Required. The panel ID.

Returns
TypeDescription
string

setPanelId

Required. The panel ID.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

The display name of the panel.

Returns
TypeDescription
string

setDisplayName

The display name of the panel.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPanelPosition

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

If set, then total_panels must also be set.

Returns
TypeDescription
int

hasPanelPosition

clearPanelPosition

setPanelPosition

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

If set, then total_panels must also be set.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getTotalPanels

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

Must be set if panel_position is set.

Returns
TypeDescription
int

hasTotalPanels

clearTotalPanels

setTotalPanels

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

Must be set if panel_position is set.

Parameter
NameDescription
var int
Returns
TypeDescription
$this