com.google.cloud.discoveryengine.v1beta

Interface RecommendResponse.RecommendationResultOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RecommendResponse.RecommendationResult, RecommendResponse.RecommendationResult.Builder

Enclosing class:

RecommendResponse

public static interface RecommendResponse.RecommendationResultOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

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;

getMetadata

@Deprecated
Map<String,com.google.protobuf.Value> getMetadata()

Deprecated.

Use getMetadataMap() instead.

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;