Interface PanelInfoOrBuilder (0.50.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.