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
    public interface PanelInfoOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getDisplayName()
      The display name of the panel.
      com.google.protobuf.ByteString getDisplayNameBytes()
      The display name of the panel.
      String getPanelId()
      Required.
      com.google.protobuf.ByteString getPanelIdBytes()
      Required.
      int getPanelPosition()
      The ordered position of the panel, if shown to the user with other panels.
      int getTotalPanels()
      The total number of panels, including this one, shown to the user.
      boolean hasPanelPosition()
      The ordered position of the panel, if shown to the user with other panels.
      boolean hasTotalPanels()
      The total number of panels, including this one, shown to the user.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • 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.