Class AdvancedCompleteQueryResponse.QuerySuggestion.Builder

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

public static final class AdvancedCompleteQueryResponse.QuerySuggestion.Builder extends com.google.protobuf.GeneratedMessage.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder> implements AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder
 Suggestions as search queries.
 
Protobuf type google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.QuerySuggestion
  • 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<AdvancedCompleteQueryResponse.QuerySuggestion.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<AdvancedCompleteQueryResponse.QuerySuggestion.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<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>
    • getDefaultInstanceForType

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

      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public AdvancedCompleteQueryResponse.QuerySuggestion.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<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>
    • mergeFrom

    • isInitialized

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

      public AdvancedCompleteQueryResponse.QuerySuggestion.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<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>
      Throws:
      IOException
    • getSuggestion

      public String getSuggestion()
       The suggestion for the query.
       
      string suggestion = 1;
      Specified by:
      getSuggestion in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder
      Returns:
      The suggestion.
    • getSuggestionBytes

      public com.google.protobuf.ByteString getSuggestionBytes()
       The suggestion for the query.
       
      string suggestion = 1;
      Specified by:
      getSuggestionBytes in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder
      Returns:
      The bytes for suggestion.
    • setSuggestion

       The suggestion for the query.
       
      string suggestion = 1;
      Parameters:
      value - The suggestion to set.
      Returns:
      This builder for chaining.
    • clearSuggestion

       The suggestion for the query.
       
      string suggestion = 1;
      Returns:
      This builder for chaining.
    • setSuggestionBytes

      public AdvancedCompleteQueryResponse.QuerySuggestion.Builder setSuggestionBytes(com.google.protobuf.ByteString value)
       The suggestion for the query.
       
      string suggestion = 1;
      Parameters:
      value - The bytes for suggestion to set.
      Returns:
      This builder for chaining.
    • getCompletableFieldPathsList

      public com.google.protobuf.ProtocolStringList getCompletableFieldPathsList()
       The unique document field paths that serve as the source of this
       suggestion if it was generated from completable fields.
      
       This field is only populated for the document-completable model.
       
      repeated string completable_field_paths = 2;
      Specified by:
      getCompletableFieldPathsList in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder
      Returns:
      A list containing the completableFieldPaths.
    • getCompletableFieldPathsCount

      public int getCompletableFieldPathsCount()
       The unique document field paths that serve as the source of this
       suggestion if it was generated from completable fields.
      
       This field is only populated for the document-completable model.
       
      repeated string completable_field_paths = 2;
      Specified by:
      getCompletableFieldPathsCount in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder
      Returns:
      The count of completableFieldPaths.
    • getCompletableFieldPaths

      public String getCompletableFieldPaths(int index)
       The unique document field paths that serve as the source of this
       suggestion if it was generated from completable fields.
      
       This field is only populated for the document-completable model.
       
      repeated string completable_field_paths = 2;
      Specified by:
      getCompletableFieldPaths in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The completableFieldPaths at the given index.
    • getCompletableFieldPathsBytes

      public com.google.protobuf.ByteString getCompletableFieldPathsBytes(int index)
       The unique document field paths that serve as the source of this
       suggestion if it was generated from completable fields.
      
       This field is only populated for the document-completable model.
       
      repeated string completable_field_paths = 2;
      Specified by:
      getCompletableFieldPathsBytes in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the completableFieldPaths at the given index.
    • setCompletableFieldPaths

      public AdvancedCompleteQueryResponse.QuerySuggestion.Builder setCompletableFieldPaths(int index, String value)
       The unique document field paths that serve as the source of this
       suggestion if it was generated from completable fields.
      
       This field is only populated for the document-completable model.
       
      repeated string completable_field_paths = 2;
      Parameters:
      index - The index to set the value at.
      value - The completableFieldPaths to set.
      Returns:
      This builder for chaining.
    • addCompletableFieldPaths

      public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addCompletableFieldPaths(String value)
       The unique document field paths that serve as the source of this
       suggestion if it was generated from completable fields.
      
       This field is only populated for the document-completable model.
       
      repeated string completable_field_paths = 2;
      Parameters:
      value - The completableFieldPaths to add.
      Returns:
      This builder for chaining.
    • addAllCompletableFieldPaths

      public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addAllCompletableFieldPaths(Iterable<String> values)
       The unique document field paths that serve as the source of this
       suggestion if it was generated from completable fields.
      
       This field is only populated for the document-completable model.
       
      repeated string completable_field_paths = 2;
      Parameters:
      values - The completableFieldPaths to add.
      Returns:
      This builder for chaining.
    • clearCompletableFieldPaths

      public AdvancedCompleteQueryResponse.QuerySuggestion.Builder clearCompletableFieldPaths()
       The unique document field paths that serve as the source of this
       suggestion if it was generated from completable fields.
      
       This field is only populated for the document-completable model.
       
      repeated string completable_field_paths = 2;
      Returns:
      This builder for chaining.
    • addCompletableFieldPathsBytes

      public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addCompletableFieldPathsBytes(com.google.protobuf.ByteString value)
       The unique document field paths that serve as the source of this
       suggestion if it was generated from completable fields.
      
       This field is only populated for the document-completable model.
       
      repeated string completable_field_paths = 2;
      Parameters:
      value - The bytes of the completableFieldPaths to add.
      Returns:
      This builder for chaining.
    • getDataStoreList

      public com.google.protobuf.ProtocolStringList getDataStoreList()
       The name of the dataStore that this suggestion belongs to.
       
      repeated string data_store = 3;
      Specified by:
      getDataStoreList in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder
      Returns:
      A list containing the dataStore.
    • getDataStoreCount

      public int getDataStoreCount()
       The name of the dataStore that this suggestion belongs to.
       
      repeated string data_store = 3;
      Specified by:
      getDataStoreCount in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder
      Returns:
      The count of dataStore.
    • getDataStore

      public String getDataStore(int index)
       The name of the dataStore that this suggestion belongs to.
       
      repeated string data_store = 3;
      Specified by:
      getDataStore in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The dataStore at the given index.
    • getDataStoreBytes

      public com.google.protobuf.ByteString getDataStoreBytes(int index)
       The name of the dataStore that this suggestion belongs to.
       
      repeated string data_store = 3;
      Specified by:
      getDataStoreBytes in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the dataStore at the given index.
    • setDataStore

      public AdvancedCompleteQueryResponse.QuerySuggestion.Builder setDataStore(int index, String value)
       The name of the dataStore that this suggestion belongs to.
       
      repeated string data_store = 3;
      Parameters:
      index - The index to set the value at.
      value - The dataStore to set.
      Returns:
      This builder for chaining.
    • addDataStore

       The name of the dataStore that this suggestion belongs to.
       
      repeated string data_store = 3;
      Parameters:
      value - The dataStore to add.
      Returns:
      This builder for chaining.
    • addAllDataStore

       The name of the dataStore that this suggestion belongs to.
       
      repeated string data_store = 3;
      Parameters:
      values - The dataStore to add.
      Returns:
      This builder for chaining.
    • clearDataStore

       The name of the dataStore that this suggestion belongs to.
       
      repeated string data_store = 3;
      Returns:
      This builder for chaining.
    • addDataStoreBytes

      public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addDataStoreBytes(com.google.protobuf.ByteString value)
       The name of the dataStore that this suggestion belongs to.
       
      repeated string data_store = 3;
      Parameters:
      value - The bytes of the dataStore to add.
      Returns:
      This builder for chaining.