Package com.google.cloud.discoveryengine.v1beta

Class RecommendResponse.RecommendationResult

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult
All Implemented Interfaces:
RecommendResponse.RecommendationResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
RecommendResponse
public static final class RecommendResponse.RecommendationResult extends com.google.protobuf.GeneratedMessage implements RecommendResponse.RecommendationResultOrBuilder
 RecommendationResult represents a generic recommendation result with
 associated metadata.
Protobuf type google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult
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()
       Resource ID of the recommended Document.
      string id = 1;
      Specified by:
      getId in interface RecommendResponse.RecommendationResultOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
       Resource ID of the recommended Document.
      string id = 1;
      Specified by:
      getIdBytes in interface RecommendResponse.RecommendationResultOrBuilder
      Returns:
      The bytes for id.

    • hasDocument

      public 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;
      Specified by:
      hasDocument in interface RecommendResponse.RecommendationResultOrBuilder
      Returns:
      Whether the document field is set.

    • getDocument

      public 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;
      Specified by:
      getDocument in interface RecommendResponse.RecommendationResultOrBuilder
      Returns:
      The document.

    • getDocumentOrBuilder

      public 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;
      Specified by:
      getDocumentOrBuilder in interface RecommendResponse.RecommendationResultOrBuilder

    • getMetadataCount

      public int getMetadataCount()
      Description copied from interface: RecommendResponse.RecommendationResultOrBuilder
       Additional Document metadata or 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;
      Specified by:
      getMetadataCount in interface RecommendResponse.RecommendationResultOrBuilder

    • containsMetadata

      public boolean containsMetadata(String key)
       Additional Document metadata or 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;
      Specified by:
      containsMetadata in interface RecommendResponse.RecommendationResultOrBuilder

    • getMetadata

      @Deprecated public Map<String,com.google.protobuf.Value> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.
      Specified by:
      getMetadata in interface RecommendResponse.RecommendationResultOrBuilder

    • getMetadataMap

      public Map<String,com.google.protobuf.Value> getMetadataMap()
       Additional Document metadata or 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;
      Specified by:
      getMetadataMap in interface RecommendResponse.RecommendationResultOrBuilder

    • getMetadataOrDefault

      public com.google.protobuf.Value getMetadataOrDefault(String key, com.google.protobuf.Value defaultValue)
       Additional Document metadata or 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;
      Specified by:
      getMetadataOrDefault in interface RecommendResponse.RecommendationResultOrBuilder

    • getMetadataOrThrow

      public com.google.protobuf.Value getMetadataOrThrow(String key)
       Additional Document metadata or 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;
      Specified by:
      getMetadataOrThrow in interface RecommendResponse.RecommendationResultOrBuilder

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

    • parseFrom

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

    • parseFrom

      public static RecommendResponse.RecommendationResult parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RecommendResponse.RecommendationResult parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static RecommendResponse.RecommendationResult parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static RecommendResponse.RecommendationResult parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RecommendResponse.RecommendationResult.Builder newBuilder()

    • newBuilder

      public static RecommendResponse.RecommendationResult.Builder newBuilder(RecommendResponse.RecommendationResult prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RecommendResponse.RecommendationResult getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RecommendResponse.RecommendationResult> parser()

    • getParserForType

      public com.google.protobuf.Parser<RecommendResponse.RecommendationResult> 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 RecommendResponse.RecommendationResult getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder