Package com.google.cloud.discoveryengine.v1beta

Class SearchResponse.SearchResult.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.Builder>
com.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.Builder
All Implemented Interfaces:
SearchResponse.SearchResultOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchResponse.SearchResult
public static final class SearchResponse.SearchResult.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.Builder> implements SearchResponse.SearchResultOrBuilder
 Represents the search results.
Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.Builder>

    • clear

      public SearchResponse.SearchResult.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<SearchResponse.SearchResult.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<SearchResponse.SearchResult.Builder>

    • getDefaultInstanceForType

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

    • build

      public SearchResponse.SearchResult build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SearchResponse.SearchResult buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public SearchResponse.SearchResult.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<SearchResponse.SearchResult.Builder>

    • mergeFrom

      public SearchResponse.SearchResult.Builder mergeFrom(SearchResponse.SearchResult other)

    • isInitialized

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

    • mergeFrom

      public SearchResponse.SearchResult.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<SearchResponse.SearchResult.Builder>
      Throws:
      IOException

    • getId

      public String getId()
       [Document.id][google.cloud.discoveryengine.v1beta.Document.id] of the
 searched [Document][google.cloud.discoveryengine.v1beta.Document].
      string id = 1;
      Specified by:
      getId in interface SearchResponse.SearchResultOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
       [Document.id][google.cloud.discoveryengine.v1beta.Document.id] of the
 searched [Document][google.cloud.discoveryengine.v1beta.Document].
      string id = 1;
      Specified by:
      getIdBytes in interface SearchResponse.SearchResultOrBuilder
      Returns:
      The bytes for id.

    • setId

      public SearchResponse.SearchResult.Builder setId(String value)
       [Document.id][google.cloud.discoveryengine.v1beta.Document.id] of the
 searched [Document][google.cloud.discoveryengine.v1beta.Document].
      string id = 1;
      Parameters:
      value - The id to set.
      Returns:
      This builder for chaining.

    • clearId

      public SearchResponse.SearchResult.Builder clearId()
       [Document.id][google.cloud.discoveryengine.v1beta.Document.id] of the
 searched [Document][google.cloud.discoveryengine.v1beta.Document].
      string id = 1;
      Returns:
      This builder for chaining.

    • setIdBytes

      public SearchResponse.SearchResult.Builder setIdBytes(com.google.protobuf.ByteString value)
       [Document.id][google.cloud.discoveryengine.v1beta.Document.id] of the
 searched [Document][google.cloud.discoveryengine.v1beta.Document].
      string id = 1;
      Parameters:
      value - The bytes for id to set.
      Returns:
      This builder for chaining.

    • hasDocument

      public boolean hasDocument()
       The document data snippet in the search response. Only fields that are
 marked as `retrievable` are populated.
      .google.cloud.discoveryengine.v1beta.Document document = 2;
      Specified by:
      hasDocument in interface SearchResponse.SearchResultOrBuilder
      Returns:
      Whether the document field is set.

    • getDocument

      public Document getDocument()
       The document data snippet in the search response. Only fields that are
 marked as `retrievable` are populated.
      .google.cloud.discoveryengine.v1beta.Document document = 2;
      Specified by:
      getDocument in interface SearchResponse.SearchResultOrBuilder
      Returns:
      The document.

    • setDocument

      public SearchResponse.SearchResult.Builder setDocument(Document value)
       The document data snippet in the search response. Only fields that are
 marked as `retrievable` are populated.
      .google.cloud.discoveryengine.v1beta.Document document = 2;

    • setDocument

      public SearchResponse.SearchResult.Builder setDocument(Document.Builder builderForValue)
       The document data snippet in the search response. Only fields that are
 marked as `retrievable` are populated.
      .google.cloud.discoveryengine.v1beta.Document document = 2;

    • mergeDocument

      public SearchResponse.SearchResult.Builder mergeDocument(Document value)
       The document data snippet in the search response. Only fields that are
 marked as `retrievable` are populated.
      .google.cloud.discoveryengine.v1beta.Document document = 2;

    • clearDocument

      public SearchResponse.SearchResult.Builder clearDocument()
       The document data snippet in the search response. Only fields that are
 marked as `retrievable` are populated.
      .google.cloud.discoveryengine.v1beta.Document document = 2;

    • getDocumentBuilder

      public Document.Builder getDocumentBuilder()
       The document data snippet in the search response. Only fields that are
 marked as `retrievable` are populated.
      .google.cloud.discoveryengine.v1beta.Document document = 2;

    • getDocumentOrBuilder

      public DocumentOrBuilder getDocumentOrBuilder()
       The document data snippet in the search response. Only fields that are
 marked as `retrievable` are populated.
      .google.cloud.discoveryengine.v1beta.Document document = 2;
      Specified by:
      getDocumentOrBuilder in interface SearchResponse.SearchResultOrBuilder

    • hasChunk

      public boolean hasChunk()
       The chunk data in the search response if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
      .google.cloud.discoveryengine.v1beta.Chunk chunk = 18;
      Specified by:
      hasChunk in interface SearchResponse.SearchResultOrBuilder
      Returns:
      Whether the chunk field is set.

    • getChunk

      public Chunk getChunk()
       The chunk data in the search response if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
      .google.cloud.discoveryengine.v1beta.Chunk chunk = 18;
      Specified by:
      getChunk in interface SearchResponse.SearchResultOrBuilder
      Returns:
      The chunk.

    • setChunk

      public SearchResponse.SearchResult.Builder setChunk(Chunk value)
       The chunk data in the search response if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
      .google.cloud.discoveryengine.v1beta.Chunk chunk = 18;

    • setChunk

      public SearchResponse.SearchResult.Builder setChunk(Chunk.Builder builderForValue)
       The chunk data in the search response if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
      .google.cloud.discoveryengine.v1beta.Chunk chunk = 18;

    • mergeChunk

      public SearchResponse.SearchResult.Builder mergeChunk(Chunk value)
       The chunk data in the search response if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
      .google.cloud.discoveryengine.v1beta.Chunk chunk = 18;

    • clearChunk

      public SearchResponse.SearchResult.Builder clearChunk()
       The chunk data in the search response if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
      .google.cloud.discoveryengine.v1beta.Chunk chunk = 18;

    • getChunkBuilder

      public Chunk.Builder getChunkBuilder()
       The chunk data in the search response if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
      .google.cloud.discoveryengine.v1beta.Chunk chunk = 18;

    • getChunkOrBuilder

      public ChunkOrBuilder getChunkOrBuilder()
       The chunk data in the search response if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
      .google.cloud.discoveryengine.v1beta.Chunk chunk = 18;
      Specified by:
      getChunkOrBuilder in interface SearchResponse.SearchResultOrBuilder

    • getModelScoresCount

      public int getModelScoresCount()
      Description copied from interface: SearchResponse.SearchResultOrBuilder
       Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;
      Specified by:
      getModelScoresCount in interface SearchResponse.SearchResultOrBuilder

    • containsModelScores

      public boolean containsModelScores(String key)
       Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;
      Specified by:
      containsModelScores in interface SearchResponse.SearchResultOrBuilder

    • getModelScores

      @Deprecated public Map<String,DoubleList> getModelScores()
      Deprecated.
      Use getModelScoresMap() instead.
      Specified by:
      getModelScores in interface SearchResponse.SearchResultOrBuilder

    • getModelScoresMap

      public Map<String,DoubleList> getModelScoresMap()
       Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;
      Specified by:
      getModelScoresMap in interface SearchResponse.SearchResultOrBuilder

    • getModelScoresOrDefault

      public DoubleList getModelScoresOrDefault(String key, DoubleList defaultValue)
       Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;
      Specified by:
      getModelScoresOrDefault in interface SearchResponse.SearchResultOrBuilder

    • getModelScoresOrThrow

      public DoubleList getModelScoresOrThrow(String key)
       Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;
      Specified by:
      getModelScoresOrThrow in interface SearchResponse.SearchResultOrBuilder

    • clearModelScores

      public SearchResponse.SearchResult.Builder clearModelScores()

    • removeModelScores

      public SearchResponse.SearchResult.Builder removeModelScores(String key)
       Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

    • getMutableModelScores

      @Deprecated public Map<String,DoubleList> getMutableModelScores()
      Deprecated.
      Use alternate mutation accessors instead.

    • putModelScores

      public SearchResponse.SearchResult.Builder putModelScores(String key, DoubleList value)
       Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

    • putAllModelScores

      public SearchResponse.SearchResult.Builder putAllModelScores(Map<String,DoubleList> values)
       Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

    • putModelScoresBuilderIfAbsent

      public DoubleList.Builder putModelScoresBuilderIfAbsent(String key)
       Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

    • hasRankSignals

      public boolean hasRankSignals()
       A set of ranking signals associated with the result.
      .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasRankSignals in interface SearchResponse.SearchResultOrBuilder
      Returns:
      Whether the rankSignals field is set.

    • getRankSignals

      public SearchResponse.SearchResult.RankSignals getRankSignals()
       A set of ranking signals associated with the result.
      .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRankSignals in interface SearchResponse.SearchResultOrBuilder
      Returns:
      The rankSignals.

    • setRankSignals

      public SearchResponse.SearchResult.Builder setRankSignals(SearchResponse.SearchResult.RankSignals value)
       A set of ranking signals associated with the result.
      .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];

    • setRankSignals

      public SearchResponse.SearchResult.Builder setRankSignals(SearchResponse.SearchResult.RankSignals.Builder builderForValue)
       A set of ranking signals associated with the result.
      .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];

    • mergeRankSignals

      public SearchResponse.SearchResult.Builder mergeRankSignals(SearchResponse.SearchResult.RankSignals value)
       A set of ranking signals associated with the result.
      .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];

    • clearRankSignals

      public SearchResponse.SearchResult.Builder clearRankSignals()
       A set of ranking signals associated with the result.
      .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getRankSignalsBuilder

      public SearchResponse.SearchResult.RankSignals.Builder getRankSignalsBuilder()
       A set of ranking signals associated with the result.
      .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getRankSignalsOrBuilder

      public SearchResponse.SearchResult.RankSignalsOrBuilder getRankSignalsOrBuilder()
       A set of ranking signals associated with the result.
      .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRankSignalsOrBuilder in interface SearchResponse.SearchResultOrBuilder