Class PanelInfo.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<PanelInfo.Builder>
com.google.cloud.discoveryengine.v1beta.PanelInfo.Builder
All Implemented Interfaces:
PanelInfoOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
PanelInfo

public static final class PanelInfo.Builder extends com.google.protobuf.GeneratedMessage.Builder<PanelInfo.Builder> implements PanelInfoOrBuilder
 Detailed panel information associated with a user event.
 
Protobuf type google.cloud.discoveryengine.v1beta.PanelInfo
  • 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.Builder<PanelInfo.Builder>
    • clear

      public PanelInfo.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<PanelInfo.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<PanelInfo.Builder>
    • getDefaultInstanceForType

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

      public PanelInfo build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public PanelInfo buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public PanelInfo.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PanelInfo.Builder>
    • mergeFrom

      public PanelInfo.Builder mergeFrom(PanelInfo other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<PanelInfo.Builder>
    • mergeFrom

      public PanelInfo.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PanelInfo.Builder>
      Throws:
      IOException
    • 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.
    • setPanelId

      public PanelInfo.Builder setPanelId(String value)
       Required. The panel ID.
       
      string panel_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The panelId to set.
      Returns:
      This builder for chaining.
    • clearPanelId

      public PanelInfo.Builder clearPanelId()
       Required. The panel ID.
       
      string panel_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.
    • setPanelIdBytes

      public PanelInfo.Builder setPanelIdBytes(com.google.protobuf.ByteString value)
       Required. The panel ID.
       
      string panel_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for panelId to set.
      Returns:
      This builder for chaining.
    • 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.
    • setDisplayName

      public PanelInfo.Builder setDisplayName(String value)
       The display name of the panel.
       
      string display_name = 3;
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.
    • clearDisplayName

      public PanelInfo.Builder clearDisplayName()
       The display name of the panel.
       
      string display_name = 3;
      Returns:
      This builder for chaining.
    • setDisplayNameBytes

      public PanelInfo.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       The display name of the panel.
       
      string display_name = 3;
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.
    • 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.
    • setPanelPosition

      public PanelInfo.Builder setPanelPosition(int value)
       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;
      Parameters:
      value - The panelPosition to set.
      Returns:
      This builder for chaining.
    • clearPanelPosition

      public PanelInfo.Builder clearPanelPosition()
       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;
      Returns:
      This builder for chaining.
    • 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.
    • setTotalPanels

      public PanelInfo.Builder setTotalPanels(int value)
       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;
      Parameters:
      value - The totalPanels to set.
      Returns:
      This builder for chaining.
    • clearTotalPanels

      public PanelInfo.Builder clearTotalPanels()
       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;
      Returns:
      This builder for chaining.
    • 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
    • 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
    • setDocuments

      public PanelInfo.Builder setDocuments(int index, DocumentInfo value)
       Optional. The document IDs associated with this panel.
       
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];
    • setDocuments

      public PanelInfo.Builder setDocuments(int index, DocumentInfo.Builder builderForValue)
       Optional. The document IDs associated with this panel.
       
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];
    • addDocuments

      public PanelInfo.Builder addDocuments(DocumentInfo value)
       Optional. The document IDs associated with this panel.
       
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];
    • addDocuments

      public PanelInfo.Builder addDocuments(int index, DocumentInfo value)
       Optional. The document IDs associated with this panel.
       
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];
    • addDocuments

      public PanelInfo.Builder addDocuments(DocumentInfo.Builder builderForValue)
       Optional. The document IDs associated with this panel.
       
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];
    • addDocuments

      public PanelInfo.Builder addDocuments(int index, DocumentInfo.Builder builderForValue)
       Optional. The document IDs associated with this panel.
       
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];
    • addAllDocuments

      public PanelInfo.Builder addAllDocuments(Iterable<? extends DocumentInfo> values)
       Optional. The document IDs associated with this panel.
       
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];
    • clearDocuments

      public PanelInfo.Builder clearDocuments()
       Optional. The document IDs associated with this panel.
       
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];
    • removeDocuments

      public PanelInfo.Builder removeDocuments(int index)
       Optional. The document IDs associated with this panel.
       
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];
    • getDocumentsBuilder

      public DocumentInfo.Builder getDocumentsBuilder(int index)
       Optional. The document IDs associated with this panel.
       
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];
    • 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
    • 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
    • addDocumentsBuilder

      public DocumentInfo.Builder addDocumentsBuilder()
       Optional. The document IDs associated with this panel.
       
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];
    • addDocumentsBuilder

      public DocumentInfo.Builder addDocumentsBuilder(int index)
       Optional. The document IDs associated with this panel.
       
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];
    • getDocumentsBuilderList

      public List<DocumentInfo.Builder> getDocumentsBuilderList()
       Optional. The document IDs associated with this panel.
       
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];