Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class PanelInfo.
Detailed panel information associated with a user event.
Generated from protobuf message google.cloud.discoveryengine.v1beta.PanelInfo
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string | |
setPanelId
Required. The panel ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
The display name of the panel.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
The display name of the panel.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTotalPanels
The total number of panels, including this one, shown to the user.
Must be set if panel_position is set.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |