Package com.google.cloud.discoveryengine.v1beta

Interface RecommendResponse.RecommendationResultOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsMetadata​(String key)
      Additional Document metadata / annotations.
      Document getDocument()
      Set if `returnDocument` is set to true in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      DocumentOrBuilder getDocumentOrBuilder()
      Set if `returnDocument` is set to true in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      String getId()
      Resource ID of the recommended Document.
      com.google.protobuf.ByteString getIdBytes()
      Resource ID of the recommended Document.
      Map<String,​com.google.protobuf.Value> getMetadata()
      Deprecated.
      int getMetadataCount()
      Additional Document metadata / annotations.
      Map<String,​com.google.protobuf.Value> getMetadataMap()
      Additional Document metadata / annotations.
      com.google.protobuf.Value getMetadataOrDefault​(String key, com.google.protobuf.Value defaultValue)
      Additional Document metadata / annotations.
      com.google.protobuf.Value getMetadataOrThrow​(String key)
      Additional Document metadata / annotations.
      boolean hasDocument()
      Set if `returnDocument` is set to true in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getId

        String getId()
         Resource ID of the recommended Document.
        string id = 1;
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         Resource ID of the recommended Document.
        string id = 1;
        Returns:
        The bytes for id.

      • hasDocument

        boolean hasDocument()
         Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
        .google.cloud.discoveryengine.v1beta.Document document = 2;
        Returns:
        Whether the document field is set.

      • getDocument

        Document getDocument()
         Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
        .google.cloud.discoveryengine.v1beta.Document document = 2;
        Returns:
        The document.

      • getDocumentOrBuilder

        DocumentOrBuilder getDocumentOrBuilder()
         Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
        .google.cloud.discoveryengine.v1beta.Document document = 2;

      • getMetadataCount

        int getMetadataCount()
         Additional Document metadata / annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
   `returnScore` is set to true in
   [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
        map<string, .google.protobuf.Value> metadata = 3;

      • containsMetadata

        boolean containsMetadata​(String key)
         Additional Document metadata / annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
   `returnScore` is set to true in
   [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
        map<string, .google.protobuf.Value> metadata = 3;

      • getMetadataMap

        Map<String,​com.google.protobuf.Value> getMetadataMap()
         Additional Document metadata / annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
   `returnScore` is set to true in
   [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
        map<string, .google.protobuf.Value> metadata = 3;

      • getMetadataOrDefault

        com.google.protobuf.Value getMetadataOrDefault​(String key,
                                               com.google.protobuf.Value defaultValue)
         Additional Document metadata / annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
   `returnScore` is set to true in
   [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
        map<string, .google.protobuf.Value> metadata = 3;

      • getMetadataOrThrow

        com.google.protobuf.Value getMetadataOrThrow​(String key)
         Additional Document metadata / annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
   `returnScore` is set to true in
   [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
        map<string, .google.protobuf.Value> metadata = 3;