Class PanelInfo

  • All Implemented Interfaces:
    PanelInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class PanelInfo
    extends com.google.protobuf.GeneratedMessageV3
    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 class  PanelInfo.Builder
      Detailed panel information associated with a user event.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static PanelInfo getDefaultInstance()  
      PanelInfo getDefaultInstanceForType()  
      static 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.
      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.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static PanelInfo.Builder newBuilder()  
      static PanelInfo.Builder newBuilder​(PanelInfo prototype)  
      PanelInfo.Builder newBuilderForType()  
      protected PanelInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      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.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
      • 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 Detail

      • 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
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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​(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
      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
      • getDefaultInstanceForType

        public PanelInfo getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder