java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - 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.GeneratedMessageV3
implements RecommendResponse.RecommendationResultOrBuilder
```
```
 RecommendationResult represents a generic recommendation result with
 associated metadata.
 
```
Protobuf type google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`RecommendResponse.RecommendationResult.Builder`	RecommendationResult represents a generic recommendation result with associated metadata.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type Field Description

static int DOCUMENT_FIELD_NUMBER

static int ID_FIELD_NUMBER

static int METADATA_FIELD_NUMBER
- Fields inherited from class com.google.protobuf.GeneratedMessageV3
  alwaysUseFieldBuilders, unknownFields
- Fields inherited from class com.google.protobuf.AbstractMessage
  memoizedSize
- Fields inherited from class com.google.protobuf.AbstractMessageLite
  memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`containsMetadata(String key)`	Additional Document metadata / annotations.
`boolean`	`equals(Object obj)`
`static RecommendResponse.RecommendationResult`	`getDefaultInstance()`
`RecommendResponse.RecommendationResult`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`com.google.protobuf.Parser<RecommendResponse.RecommendationResult>`	`getParserForType()`
`int`	`getSerializedSize()`
`boolean`	`hasDocument()`	Set if `returnDocument` is set to true in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static RecommendResponse.RecommendationResult.Builder`	`newBuilder()`
`static RecommendResponse.RecommendationResult.Builder`	`newBuilder(RecommendResponse.RecommendationResult prototype)`
`RecommendResponse.RecommendationResult.Builder`	`newBuilderForType()`
`protected RecommendResponse.RecommendationResult.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static RecommendResponse.RecommendationResult`	`parseDelimitedFrom(InputStream input)`
`static RecommendResponse.RecommendationResult`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RecommendResponse.RecommendationResult`	`parseFrom(byte[] data)`
`static RecommendResponse.RecommendationResult`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RecommendResponse.RecommendationResult`	`parseFrom(com.google.protobuf.ByteString data)`
`static RecommendResponse.RecommendationResult`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RecommendResponse.RecommendationResult`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static RecommendResponse.RecommendationResult`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RecommendResponse.RecommendationResult`	`parseFrom(InputStream input)`
`static RecommendResponse.RecommendationResult`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RecommendResponse.RecommendationResult`	`parseFrom(ByteBuffer data)`
`static RecommendResponse.RecommendationResult`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<RecommendResponse.RecommendationResult>`	`parser()`
`RecommendResponse.RecommendationResult.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail
- ID_FIELD_NUMBER
```
public static final int ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DOCUMENT_FIELD_NUMBER
```
public static final int DOCUMENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- METADATA_FIELD_NUMBER
```
public static final int METADATA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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