View Source GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1PanelInfo (google_api_discovery_engine v0.27.0)

Detailed panel information associated with a user event.

Attributes

displayName (type: String.t, default: nil) - The display name of the panel.
documents (type: list(GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DocumentInfo.t), default: nil) - Optional. The document IDs associated with this panel.
panelId (type: String.t, default: nil) - Required. The panel ID.
panelPosition (type: integer(), default: nil) - The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.
totalPanels (type: integer(), default: nil) - The total number of panels, including this one, shown to the user. Must be set if panel_position is set.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1PanelInfo{
    displayName: String.t() | nil,
    documents:
      [
        GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DocumentInfo.t()
      ]
      | nil,
    panelId: String.t() | nil,
    panelPosition: integer() | nil,
    totalPanels: integer() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.