Class PanelInfo (0.18.0)

public final class PanelInfo extends GeneratedMessageV3 implements PanelInfoOrBuilder

Detailed panel information associated with a user event.

Protobuf type google.cloud.discoveryengine.v1.PanelInfo

Implements

PanelInfoOrBuilder

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PANEL_ID_FIELD_NUMBER

public static final int PANEL_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PANEL_POSITION_FIELD_NUMBER

public static final int PANEL_POSITION_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_PANELS_FIELD_NUMBER

public static final int TOTAL_PANELS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PanelInfo getDefaultInstance()
Returns
TypeDescription
PanelInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PanelInfo.Builder newBuilder()
Returns
TypeDescription
PanelInfo.Builder

newBuilder(PanelInfo prototype)

public static PanelInfo.Builder newBuilder(PanelInfo prototype)
Parameter
NameDescription
prototypePanelInfo
Returns
TypeDescription
PanelInfo.Builder

parseDelimitedFrom(InputStream input)

public static PanelInfo parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PanelInfo
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PanelInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PanelInfo
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PanelInfo parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PanelInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PanelInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PanelInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PanelInfo parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PanelInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PanelInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PanelInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PanelInfo parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PanelInfo
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PanelInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PanelInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PanelInfo parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PanelInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PanelInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PanelInfo
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PanelInfo parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PanelInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PanelInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PanelInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PanelInfo> parser()
Returns
TypeDescription
Parser<PanelInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PanelInfo getDefaultInstanceForType()
Returns
TypeDescription
PanelInfo

getDisplayName()

public String getDisplayName()

The display name of the panel.

string display_name = 3;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the panel.

string display_name = 3;

Returns
TypeDescription
ByteString

The bytes for displayName.

getPanelId()

public String getPanelId()

Required. The panel ID.

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

Returns
TypeDescription
String

The panelId.

getPanelIdBytes()

public ByteString getPanelIdBytes()

Required. The panel ID.

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

Returns
TypeDescription
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
TypeDescription
int

The panelPosition.

getParserForType()

public Parser<PanelInfo> getParserForType()
Returns
TypeDescription
Parser<PanelInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the totalPanels field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PanelInfo.Builder newBuilderForType()
Returns
TypeDescription
PanelInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PanelInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PanelInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PanelInfo.Builder toBuilder()
Returns
TypeDescription
PanelInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException