public final class PanelInfo extends GeneratedMessageV3 implements PanelInfoOrBuilder
Detailed panel information associated with a user event.
Protobuf type google.cloud.discoveryengine.v1beta.PanelInfo
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
DOCUMENTS_FIELD_NUMBER
public static final int DOCUMENTS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
PANEL_ID_FIELD_NUMBER
public static final int PANEL_ID_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
PANEL_POSITION_FIELD_NUMBER
public static final int PANEL_POSITION_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
TOTAL_PANELS_FIELD_NUMBER
public static final int TOTAL_PANELS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static PanelInfo getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PanelInfo.Builder newBuilder()
newBuilder(PanelInfo prototype)
public static PanelInfo.Builder newBuilder(PanelInfo prototype)
Parameter |
Name |
Description |
prototype |
PanelInfo
|
public static PanelInfo parseDelimitedFrom(InputStream input)
public static PanelInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PanelInfo parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PanelInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PanelInfo parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PanelInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PanelInfo parseFrom(CodedInputStream input)
public static PanelInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PanelInfo parseFrom(InputStream input)
public static PanelInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PanelInfo parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PanelInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PanelInfo> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public PanelInfo getDefaultInstanceForType()
getDisplayName()
public String getDisplayName()
The display name of the panel.
string display_name = 3;
Returns |
Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
The display name of the panel.
string display_name = 3;
Returns |
Type |
Description |
ByteString |
The bytes for displayName.
|
getDocuments(int index)
public 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
|
getDocumentsCount()
public 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 List<DocumentInfo> getDocumentsList()
Optional. The document IDs associated with this panel.
repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];
getDocumentsOrBuilder(int index)
public 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
|
getDocumentsOrBuilderList()
public 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 String getPanelId()
Required. The panel ID.
string panel_id = 2 [(.google.api.field_behavior) = REQUIRED];
Returns |
Type |
Description |
String |
The panelId.
|
getPanelIdBytes()
public 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 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.
|
getParserForType()
public Parser<PanelInfo> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
getTotalPanels()
public 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 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 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.
|
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PanelInfo.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PanelInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public PanelInfo.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides