Package com.google.cloud.discoveryengine.v1beta

Class PanelInfo

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1beta.PanelInfo

All Implemented Interfaces:

PanelInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated
public final class PanelInfo
extends com.google.protobuf.GeneratedMessage
implements PanelInfoOrBuilder

 Detailed panel information associated with a user event.
 

Protobuf type google.cloud.discoveryengine.v1beta.PanelInfo

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PanelInfo.Builder	Detailed panel information associated with a user event.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DISPLAY_NAME_FIELD_NUMBER
static final int	DOCUMENTS_FIELD_NUMBER
static final int	PANEL_ID_FIELD_NUMBER
static final int	PANEL_POSITION_FIELD_NUMBER
static final int	TOTAL_PANELS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static PanelInfo	getDefaultInstance()
PanelInfo	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName()	The display name of the panel.
com.google.protobuf.ByteString	getDisplayNameBytes()	The display name of the panel.
DocumentInfo	getDocuments(int index)	Optional.
int	getDocumentsCount()	Optional.
List<DocumentInfo>	getDocumentsList()	Optional.
DocumentInfoOrBuilder	getDocumentsOrBuilder(int index)	Optional.
List<? extends DocumentInfoOrBuilder>	getDocumentsOrBuilderList()	Optional.
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.
com.google.protobuf.Parser<PanelInfo>	getParserForType()
int	getSerializedSize()
int	getTotalPanels()	The total number of panels, including this one, shown to the user.
int	hashCode()
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.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static PanelInfo.Builder	newBuilder()
static PanelInfo.Builder	newBuilder(PanelInfo prototype)
PanelInfo.Builder	newBuilderForType()
protected PanelInfo.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static PanelInfo	parseDelimitedFrom(InputStream input)
static PanelInfo	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PanelInfo	parseFrom(byte[] data)
static PanelInfo	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PanelInfo	parseFrom(com.google.protobuf.ByteString data)
static PanelInfo	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PanelInfo	parseFrom(com.google.protobuf.CodedInputStream input)
static PanelInfo	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PanelInfo	parseFrom(InputStream input)
static PanelInfo	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PanelInfo	parseFrom(ByteBuffer data)
static PanelInfo	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PanelInfo>	parser()
PanelInfo.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

PANEL_ID_FIELD_NUMBER

public static final int PANEL_ID_FIELD_NUMBER

See Also:

• Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

• Constant Field Values

PANEL_POSITION_FIELD_NUMBER

public static final int PANEL_POSITION_FIELD_NUMBER

See Also:

• Constant Field Values

TOTAL_PANELS_FIELD_NUMBER

public static final int TOTAL_PANELS_FIELD_NUMBER

See Also:

• Constant Field Values

DOCUMENTS_FIELD_NUMBER

public static final int DOCUMENTS_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getPanelId

public String getPanelId()

 Required. The panel ID.
 

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

Specified by:

getPanelId in interface PanelInfoOrBuilder

Returns:

The panelId.

getPanelIdBytes

public com.google.protobuf.ByteString getPanelIdBytes()

 Required. The panel ID.
 

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

Specified by:

getPanelIdBytes in interface PanelInfoOrBuilder

Returns:

The bytes for panelId.

getDisplayName

public String getDisplayName()

 The display name of the panel.
 

string display_name = 3;

Specified by:

getDisplayName in interface PanelInfoOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 The display name of the panel.
 

string display_name = 3;

Specified by:

getDisplayNameBytes in interface PanelInfoOrBuilder

Returns:

The bytes for displayName.

hasPanelPosition

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

Specified by:

hasPanelPosition in interface PanelInfoOrBuilder

Returns:

Whether the panelPosition field is set.

getPanelPosition

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

Specified by:

getPanelPosition in interface PanelInfoOrBuilder

Returns:

The panelPosition.

hasTotalPanels

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

Specified by:

hasTotalPanels in interface PanelInfoOrBuilder

Returns:

Whether the totalPanels field is set.

getTotalPanels

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

Specified by:

getTotalPanels in interface PanelInfoOrBuilder

Returns:

The totalPanels.

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

Specified by:

getDocumentsList in interface PanelInfoOrBuilder

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

Specified by:

getDocumentsOrBuilderList in interface PanelInfoOrBuilder

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

Specified by:

getDocumentsCount in interface PanelInfoOrBuilder

getDocuments

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

Specified by:

getDocuments in interface PanelInfoOrBuilder

getDocumentsOrBuilder

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

Specified by:

getDocumentsOrBuilder in interface PanelInfoOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static PanelInfo parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PanelInfo parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PanelInfo parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PanelInfo parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PanelInfo parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PanelInfo parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PanelInfo parseFrom(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static PanelInfo parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static PanelInfo parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static PanelInfo parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseFrom

public static PanelInfo parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static PanelInfo parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

newBuilderForType

public PanelInfo.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PanelInfo.Builder newBuilder()

newBuilder

public static PanelInfo.Builder newBuilder(PanelInfo prototype)

toBuilder

public PanelInfo.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PanelInfo.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static PanelInfo getDefaultInstance()

parser

public static com.google.protobuf.Parser<PanelInfo> parser()

getParserForType

public com.google.protobuf.Parser<PanelInfo> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public PanelInfo getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder