Package com.google.cloud.discoveryengine.v1beta

Class RecommendResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.RecommendResponse
All Implemented Interfaces:
RecommendResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RecommendResponse extends com.google.protobuf.GeneratedMessage implements RecommendResponseOrBuilder
 Response message for Recommend method.
Protobuf type google.cloud.discoveryengine.v1beta.RecommendResponse
See Also:

  • Field Details

    • RESULTS_FIELD_NUMBER

      public static final int RESULTS_FIELD_NUMBER
      See Also:

    • ATTRIBUTION_TOKEN_FIELD_NUMBER

      public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER
      See Also:

    • MISSING_IDS_FIELD_NUMBER

      public static final int MISSING_IDS_FIELD_NUMBER
      See Also:

    • VALIDATE_ONLY_FIELD_NUMBER

      public static final int VALIDATE_ONLY_FIELD_NUMBER
      See Also:

  • 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

    • getResultsList

      public List<RecommendResponse.RecommendationResult> getResultsList()
       A list of recommended Documents. The order represents the ranking (from the
 most relevant Document to the least).
      repeated .google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult results = 1;
      Specified by:
      getResultsList in interface RecommendResponseOrBuilder

    • getResultsOrBuilderList

      public List<? extends RecommendResponse.RecommendationResultOrBuilder> getResultsOrBuilderList()
       A list of recommended Documents. The order represents the ranking (from the
 most relevant Document to the least).
      repeated .google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult results = 1;
      Specified by:
      getResultsOrBuilderList in interface RecommendResponseOrBuilder

    • getResultsCount

      public int getResultsCount()
       A list of recommended Documents. The order represents the ranking (from the
 most relevant Document to the least).
      repeated .google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult results = 1;
      Specified by:
      getResultsCount in interface RecommendResponseOrBuilder

    • getResults

      public RecommendResponse.RecommendationResult getResults(int index)
       A list of recommended Documents. The order represents the ranking (from the
 most relevant Document to the least).
      repeated .google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult results = 1;
      Specified by:
      getResults in interface RecommendResponseOrBuilder

    • getResultsOrBuilder

      public RecommendResponse.RecommendationResultOrBuilder getResultsOrBuilder(int index)
       A list of recommended Documents. The order represents the ranking (from the
 most relevant Document to the least).
      repeated .google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult results = 1;
      Specified by:
      getResultsOrBuilder in interface RecommendResponseOrBuilder

    • getAttributionToken

      public String getAttributionToken()
       A unique attribution token. This should be included in the
 [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting
 from this recommendation, which enables accurate attribution of
 recommendation model performance.
      string attribution_token = 2;
      Specified by:
      getAttributionToken in interface RecommendResponseOrBuilder
      Returns:
      The attributionToken.

    • getAttributionTokenBytes

      public com.google.protobuf.ByteString getAttributionTokenBytes()
       A unique attribution token. This should be included in the
 [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting
 from this recommendation, which enables accurate attribution of
 recommendation model performance.
      string attribution_token = 2;
      Specified by:
      getAttributionTokenBytes in interface RecommendResponseOrBuilder
      Returns:
      The bytes for attributionToken.

    • getMissingIdsList

      public com.google.protobuf.ProtocolStringList getMissingIdsList()
       IDs of documents in the request that were missing from the default Branch
 associated with the requested ServingConfig.
      repeated string missing_ids = 3;
      Specified by:
      getMissingIdsList in interface RecommendResponseOrBuilder
      Returns:
      A list containing the missingIds.

    • getMissingIdsCount

      public int getMissingIdsCount()
       IDs of documents in the request that were missing from the default Branch
 associated with the requested ServingConfig.
      repeated string missing_ids = 3;
      Specified by:
      getMissingIdsCount in interface RecommendResponseOrBuilder
      Returns:
      The count of missingIds.

    • getMissingIds

      public String getMissingIds(int index)
       IDs of documents in the request that were missing from the default Branch
 associated with the requested ServingConfig.
      repeated string missing_ids = 3;
      Specified by:
      getMissingIds in interface RecommendResponseOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The missingIds at the given index.

    • getMissingIdsBytes

      public com.google.protobuf.ByteString getMissingIdsBytes(int index)
       IDs of documents in the request that were missing from the default Branch
 associated with the requested ServingConfig.
      repeated string missing_ids = 3;
      Specified by:
      getMissingIdsBytes in interface RecommendResponseOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the missingIds at the given index.

    • getValidateOnly

      public boolean getValidateOnly()
       True if
 [RecommendRequest.validate_only][google.cloud.discoveryengine.v1beta.RecommendRequest.validate_only]
 was set.
      bool validate_only = 4;
      Specified by:
      getValidateOnly in interface RecommendResponseOrBuilder
      Returns:
      The validateOnly.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RecommendResponse 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 parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RecommendResponse.Builder newBuilder()

    • newBuilder

      public static RecommendResponse.Builder newBuilder(RecommendResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RecommendResponse getDefaultInstance()

    • parser

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

    • getParserForType

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