Class RecommendResponse.RecommendationResult (0.40.0)
Version 0.40.0keyboard_arrow_down
public static final class RecommendResponse . RecommendationResult extends GeneratedMessageV3 implements RecommendResponse . RecommendationResultOrBuilder
RecommendationResult represents a generic recommendation result with
associated metadata.
Protobuf type
google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DOCUMENT_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER
Field Value
Type Description
int
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
Type Description
int
public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static RecommendResponse . RecommendationResult getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static RecommendResponse . RecommendationResult . Builder newBuilder ()
newBuilder(RecommendResponse.RecommendationResult prototype)
public static RecommendResponse . RecommendationResult . Builder newBuilder ( RecommendResponse . RecommendationResult prototype )
public static RecommendResponse . RecommendationResult parseDelimitedFrom ( InputStream input )
public static RecommendResponse . RecommendationResult parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static RecommendResponse . RecommendationResult parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RecommendResponse . RecommendationResult parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static RecommendResponse . RecommendationResult parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RecommendResponse . RecommendationResult parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static RecommendResponse . RecommendationResult parseFrom ( CodedInputStream input )
public static RecommendResponse . RecommendationResult parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static RecommendResponse . RecommendationResult parseFrom ( InputStream input )
public static RecommendResponse . RecommendationResult parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static RecommendResponse . RecommendationResult parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RecommendResponse . RecommendationResult parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<RecommendResponse . RecommendationResult > parser ()
Methods
public 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 .
map<string, .google.protobuf.Value> metadata = 3;
Parameter
Name Description
keyString
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public RecommendResponse . RecommendationResult getDefaultInstanceForType ()
getDocument()
public Document getDocument ()
Set if returnDocument is set to true in
RecommendRequest.params .
.google.cloud.discoveryengine.v1alpha.Document document = 2;
Returns
Type Description
Document The document.
getDocumentOrBuilder()
public DocumentOrBuilder getDocumentOrBuilder ()
Set if returnDocument is set to true in
RecommendRequest.params .
.google.cloud.discoveryengine.v1alpha.Document document = 2;
getId()
Resource ID of the recommended Document.
string id = 1;
Returns
Type Description
String The id.
getIdBytes()
public ByteString getIdBytes ()
Resource ID of the recommended Document.
string id = 1;
Returns
Type Description
ByteString The bytes for id.
public Map<String , Value > getMetadata ()
public 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 .
map<string, .google.protobuf.Value> metadata = 3;
Returns
Type Description
int
public Map<String , 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 .
map<string, .google.protobuf.Value> metadata = 3;
public Value getMetadataOrDefault ( String key , 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 .
map<string, .google.protobuf.Value> metadata = 3;
Parameters
Name Description
keyString
defaultValueValue
Returns
Type Description
Value
public 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 .
map<string, .google.protobuf.Value> metadata = 3;
Parameter
Name Description
keyString
Returns
Type Description
Value
getParserForType()
public Parser<RecommendResponse . RecommendationResult > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hasDocument()
public boolean hasDocument ()
Set if returnDocument is set to true in
RecommendRequest.params .
.google.cloud.discoveryengine.v1alpha.Document document = 2;
Returns
Type Description
boolean Whether the document field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection ( int number )
Parameter
Name Description
numberint
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public RecommendResponse . RecommendationResult . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RecommendResponse . RecommendationResult . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public RecommendResponse . RecommendationResult . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
