Interface PanelInfoOrBuilder (0.51.0)

Version latest

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface PanelInfoOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDisplayName()

public abstract String getDisplayName()

The display name of the panel.

string display_name = 3;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

The display name of the panel.

string display_name = 3;

Returns
Type	Description
ByteString	The bytes for displayName.

getDocuments(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
DocumentInfo

getDocumentsCount()

public abstract int getDocumentsCount()

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getDocumentsList()

public abstract List<DocumentInfo> getDocumentsList()

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<DocumentInfo>

getDocumentsOrBuilder(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
DocumentInfoOrBuilder

getDocumentsOrBuilderList()

public abstract 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];

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1beta.DocumentInfoOrBuilder>

getPanelId()

public abstract String getPanelId()

Required. The panel ID.

string panel_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The panelId.

getPanelIdBytes()

public abstract ByteString getPanelIdBytes()

Required. The panel ID.

string panel_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for panelId.

getPanelPosition()

public abstract int getPanelPosition()

The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.

optional int32 panel_position = 4;

Returns
Type	Description
int	The panelPosition.

getTotalPanels()

public abstract int getTotalPanels()

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

optional int32 total_panels = 5;

Returns
Type	Description
int	The totalPanels.

hasPanelPosition()

public abstract boolean hasPanelPosition()

The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.

optional int32 panel_position = 4;

Returns
Type	Description
boolean	Whether the panelPosition field is set.

hasTotalPanels()

public abstract boolean hasTotalPanels()

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

optional int32 total_panels = 5;

Returns
Type	Description
boolean	Whether the totalPanels field is set.