Package com.google.cloud.discoveryengine.v1beta

Class SearchResponse.SearchResult

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

  • Field Details

  • 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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.

    • 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.

    • 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.

    • 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

    • 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.

    • 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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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 SearchResponse.SearchResult parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchResponse.SearchResult parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchResponse.SearchResult parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchResponse.SearchResult parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchResponse.SearchResult parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchResponse.SearchResult parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchResponse.SearchResult parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchResponse.SearchResult parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchResponse.SearchResult parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchResponse.SearchResult parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchResponse.SearchResult parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchResponse.SearchResult parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static SearchResponse.SearchResult.Builder newBuilder()

    • newBuilder

      public static SearchResponse.SearchResult.Builder newBuilder(SearchResponse.SearchResult prototype)

    • toBuilder

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

    • newBuilderForType

      protected SearchResponse.SearchResult.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchResponse.SearchResult getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchResponse.SearchResult> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchResponse.SearchResult> 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.GeneratedMessage

    • getDefaultInstanceForType

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