Interface RecommendResponse.RecommendationResultOrBuilder (0.42.0)

Version 0.42.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface RecommendResponse.RecommendationResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract 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.

map<string, .google.protobuf.Value> metadata = 3;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getDocument()

public abstract 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 abstract DocumentOrBuilder getDocumentOrBuilder()

Set if returnDocument is set to true in RecommendRequest.params.

.google.cloud.discoveryengine.v1alpha.Document document = 2;

Returns
Type	Description
DocumentOrBuilder

getId()

public abstract String getId()

Resource ID of the recommended Document.

string id = 1;

Returns
Type	Description
String	The id.

getIdBytes()

public abstract ByteString getIdBytes()

Resource ID of the recommended Document.

string id = 1;

Returns
Type	Description
ByteString	The bytes for id.

getMetadata() (deprecated)

public abstract Map<String,Value> getMetadata()

Use #getMetadataMap() instead.

Returns
Type	Description
Map<String,Value>

getMetadataCount()

public abstract int getMetadataCount()

Additional Document metadata or 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

getMetadataMap()

public abstract Map<String,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.

map<string, .google.protobuf.Value> metadata = 3;

Returns
Type	Description
Map<String,Value>

getMetadataOrDefault(String key, Value defaultValue)

public abstract Value getMetadataOrDefault(String key, 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.

map<string, .google.protobuf.Value> metadata = 3;

Parameters
Name	Description
key	String
defaultValue	Value

Returns
Type	Description
Value

getMetadataOrThrow(String key)

public abstract 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.

map<string, .google.protobuf.Value> metadata = 3;

Parameter
Name	Description
key	String

Returns
Type	Description
Value

hasDocument()

public abstract 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.