Package com.google.cloud.discoveryengine.v1beta

Interface PanelInfoOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PanelInfo, PanelInfo.Builder
@Generated public interface PanelInfoOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getPanelId

      String getPanelId()
       Required. The panel ID.
      string panel_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The panelId.

    • getPanelIdBytes

      com.google.protobuf.ByteString getPanelIdBytes()
       Required. The panel ID.
      string panel_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for panelId.

    • getDisplayName

      String getDisplayName()
       The display name of the panel.
      string display_name = 3;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       The display name of the panel.
      string display_name = 3;
      Returns:
      The bytes for displayName.

    • hasPanelPosition

      boolean hasPanelPosition()
       The ordered position of the panel, if shown to the user with other panels.
 If set, then
 [total_panels][google.cloud.discoveryengine.v1beta.PanelInfo.total_panels]
 must also be set.
      optional int32 panel_position = 4;
      Returns:
      Whether the panelPosition field is set.

    • getPanelPosition

      int getPanelPosition()
       The ordered position of the panel, if shown to the user with other panels.
 If set, then
 [total_panels][google.cloud.discoveryengine.v1beta.PanelInfo.total_panels]
 must also be set.
      optional int32 panel_position = 4;
      Returns:
      The panelPosition.

    • hasTotalPanels

      boolean hasTotalPanels()
       The total number of panels, including this one, shown to the user.
 Must be set if
 [panel_position][google.cloud.discoveryengine.v1beta.PanelInfo.panel_position]
 is set.
      optional int32 total_panels = 5;
      Returns:
      Whether the totalPanels field is set.

    • getTotalPanels

      int getTotalPanels()
       The total number of panels, including this one, shown to the user.
 Must be set if
 [panel_position][google.cloud.discoveryengine.v1beta.PanelInfo.panel_position]
 is set.
      optional int32 total_panels = 5;
      Returns:
      The totalPanels.

    • getDocumentsList

      List<DocumentInfo> getDocumentsList()
       Optional. The document IDs associated with this panel.
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getDocuments

      DocumentInfo getDocuments(int index)
       Optional. The document IDs associated with this panel.
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getDocumentsCount

      int getDocumentsCount()
       Optional. The document IDs associated with this panel.
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getDocumentsOrBuilderList

      List<? extends DocumentInfoOrBuilder> getDocumentsOrBuilderList()
       Optional. The document IDs associated with this panel.
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getDocumentsOrBuilder

      DocumentInfoOrBuilder getDocumentsOrBuilder(int index)
       Optional. The document IDs associated with this panel.
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];