public static final class RecommendResponse.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.Builder> implements RecommendResponseOrBuilder
Response message for Recommend method.Protobuf type
google.cloud.discoveryengine.v1beta.RecommendResponse| Modifier and Type | Method and Description |
|---|---|
RecommendResponse.Builder |
addAllMissingIds(Iterable<String> values)
IDs of documents in the request that were missing from the default Branch
associated with the requested ServingConfig.
|
RecommendResponse.Builder |
addAllResults(Iterable<? extends RecommendResponse.RecommendationResult> values)
A list of recommended Documents.
|
RecommendResponse.Builder |
addMissingIds(String value)
IDs of documents in the request that were missing from the default Branch
associated with the requested ServingConfig.
|
RecommendResponse.Builder |
addMissingIdsBytes(com.google.protobuf.ByteString value)
IDs of documents in the request that were missing from the default Branch
associated with the requested ServingConfig.
|
RecommendResponse.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
RecommendResponse.Builder |
addResults(int index,
RecommendResponse.RecommendationResult.Builder builderForValue)
A list of recommended Documents.
|
RecommendResponse.Builder |
addResults(int index,
RecommendResponse.RecommendationResult value)
A list of recommended Documents.
|
RecommendResponse.Builder |
addResults(RecommendResponse.RecommendationResult.Builder builderForValue)
A list of recommended Documents.
|
RecommendResponse.Builder |
addResults(RecommendResponse.RecommendationResult value)
A list of recommended Documents.
|
RecommendResponse.RecommendationResult.Builder |
addResultsBuilder()
A list of recommended Documents.
|
RecommendResponse.RecommendationResult.Builder |
addResultsBuilder(int index)
A list of recommended Documents.
|
RecommendResponse |
build() |
RecommendResponse |
buildPartial() |
RecommendResponse.Builder |
clear() |
RecommendResponse.Builder |
clearAttributionToken()
A unique attribution token.
|
RecommendResponse.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
RecommendResponse.Builder |
clearMissingIds()
IDs of documents in the request that were missing from the default Branch
associated with the requested ServingConfig.
|
RecommendResponse.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
RecommendResponse.Builder |
clearResults()
A list of recommended Documents.
|
RecommendResponse.Builder |
clearValidateOnly()
True if
[RecommendRequest.validate_only][google.cloud.discoveryengine.v1beta.RecommendRequest.validate_only]
was set.
|
RecommendResponse.Builder |
clone() |
String |
getAttributionToken()
A unique attribution token.
|
com.google.protobuf.ByteString |
getAttributionTokenBytes()
A unique attribution token.
|
RecommendResponse |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getMissingIds(int index)
IDs of documents in the request that were missing from the default Branch
associated with the requested ServingConfig.
|
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.
|
int |
getMissingIdsCount()
IDs of documents in the request that were missing from the default Branch
associated with the requested ServingConfig.
|
com.google.protobuf.ProtocolStringList |
getMissingIdsList()
IDs of documents in the request that were missing from the default Branch
associated with the requested ServingConfig.
|
RecommendResponse.RecommendationResult |
getResults(int index)
A list of recommended Documents.
|
RecommendResponse.RecommendationResult.Builder |
getResultsBuilder(int index)
A list of recommended Documents.
|
List<RecommendResponse.RecommendationResult.Builder> |
getResultsBuilderList()
A list of recommended Documents.
|
int |
getResultsCount()
A list of recommended Documents.
|
List<RecommendResponse.RecommendationResult> |
getResultsList()
A list of recommended Documents.
|
RecommendResponse.RecommendationResultOrBuilder |
getResultsOrBuilder(int index)
A list of recommended Documents.
|
List<? extends RecommendResponse.RecommendationResultOrBuilder> |
getResultsOrBuilderList()
A list of recommended Documents.
|
boolean |
getValidateOnly()
True if
[RecommendRequest.validate_only][google.cloud.discoveryengine.v1beta.RecommendRequest.validate_only]
was set.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
RecommendResponse.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
RecommendResponse.Builder |
mergeFrom(com.google.protobuf.Message other) |
RecommendResponse.Builder |
mergeFrom(RecommendResponse other) |
RecommendResponse.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
RecommendResponse.Builder |
removeResults(int index)
A list of recommended Documents.
|
RecommendResponse.Builder |
setAttributionToken(String value)
A unique attribution token.
|
RecommendResponse.Builder |
setAttributionTokenBytes(com.google.protobuf.ByteString value)
A unique attribution token.
|
RecommendResponse.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
RecommendResponse.Builder |
setMissingIds(int index,
String value)
IDs of documents in the request that were missing from the default Branch
associated with the requested ServingConfig.
|
RecommendResponse.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
RecommendResponse.Builder |
setResults(int index,
RecommendResponse.RecommendationResult.Builder builderForValue)
A list of recommended Documents.
|
RecommendResponse.Builder |
setResults(int index,
RecommendResponse.RecommendationResult value)
A list of recommended Documents.
|
RecommendResponse.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
RecommendResponse.Builder |
setValidateOnly(boolean value)
True if
[RecommendRequest.validate_only][google.cloud.discoveryengine.v1beta.RecommendRequest.validate_only]
was set.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.Builder>public RecommendResponse.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.Builder>public RecommendResponse getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic RecommendResponse build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic RecommendResponse buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic RecommendResponse.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.Builder>public RecommendResponse.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.Builder>public RecommendResponse.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.Builder>public RecommendResponse.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.Builder>public RecommendResponse.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.Builder>public RecommendResponse.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.Builder>public RecommendResponse.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RecommendResponse.Builder>public RecommendResponse.Builder mergeFrom(RecommendResponse other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.Builder>public RecommendResponse.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RecommendResponse.Builder>IOExceptionpublic 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;
getResultsList in interface RecommendResponseOrBuilderpublic 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;
getResultsCount in interface RecommendResponseOrBuilderpublic 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;
getResults in interface RecommendResponseOrBuilderpublic RecommendResponse.Builder setResults(int index, RecommendResponse.RecommendationResult value)
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;
public RecommendResponse.Builder setResults(int index, RecommendResponse.RecommendationResult.Builder builderForValue)
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;
public RecommendResponse.Builder addResults(RecommendResponse.RecommendationResult value)
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;
public RecommendResponse.Builder addResults(int index, RecommendResponse.RecommendationResult value)
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;
public RecommendResponse.Builder addResults(RecommendResponse.RecommendationResult.Builder builderForValue)
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;
public RecommendResponse.Builder addResults(int index, RecommendResponse.RecommendationResult.Builder builderForValue)
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;
public RecommendResponse.Builder addAllResults(Iterable<? extends RecommendResponse.RecommendationResult> values)
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;
public RecommendResponse.Builder clearResults()
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;
public RecommendResponse.Builder removeResults(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;
public RecommendResponse.RecommendationResult.Builder getResultsBuilder(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;
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;
getResultsOrBuilder in interface RecommendResponseOrBuilderpublic 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;
getResultsOrBuilderList in interface RecommendResponseOrBuilderpublic RecommendResponse.RecommendationResult.Builder addResultsBuilder()
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;
public RecommendResponse.RecommendationResult.Builder addResultsBuilder(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;
public List<RecommendResponse.RecommendationResult.Builder> getResultsBuilderList()
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;
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;getAttributionToken in interface RecommendResponseOrBuilderpublic 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;getAttributionTokenBytes in interface RecommendResponseOrBuilderpublic RecommendResponse.Builder setAttributionToken(String value)
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;value - The attributionToken to set.public RecommendResponse.Builder clearAttributionToken()
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;public RecommendResponse.Builder setAttributionTokenBytes(com.google.protobuf.ByteString value)
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;value - The bytes for attributionToken to set.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;getMissingIdsList in interface RecommendResponseOrBuilderpublic 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;getMissingIdsCount in interface RecommendResponseOrBuilderpublic 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;getMissingIds in interface RecommendResponseOrBuilderindex - The index of the element to return.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;getMissingIdsBytes in interface RecommendResponseOrBuilderindex - The index of the value to return.public RecommendResponse.Builder setMissingIds(int index, String value)
IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.
repeated string missing_ids = 3;index - The index to set the value at.value - The missingIds to set.public RecommendResponse.Builder addMissingIds(String value)
IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.
repeated string missing_ids = 3;value - The missingIds to add.public RecommendResponse.Builder addAllMissingIds(Iterable<String> values)
IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.
repeated string missing_ids = 3;values - The missingIds to add.public RecommendResponse.Builder clearMissingIds()
IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.
repeated string missing_ids = 3;public RecommendResponse.Builder addMissingIdsBytes(com.google.protobuf.ByteString value)
IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.
repeated string missing_ids = 3;value - The bytes of the missingIds to add.public boolean getValidateOnly()
True if [RecommendRequest.validate_only][google.cloud.discoveryengine.v1beta.RecommendRequest.validate_only] was set.
bool validate_only = 4;getValidateOnly in interface RecommendResponseOrBuilderpublic RecommendResponse.Builder setValidateOnly(boolean value)
True if [RecommendRequest.validate_only][google.cloud.discoveryengine.v1beta.RecommendRequest.validate_only] was set.
bool validate_only = 4;value - The validateOnly to set.public RecommendResponse.Builder clearValidateOnly()
True if [RecommendRequest.validate_only][google.cloud.discoveryengine.v1beta.RecommendRequest.validate_only] was set.
bool validate_only = 4;public final RecommendResponse.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.Builder>public final RecommendResponse.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.Builder>Copyright © 2025 Google LLC. All rights reserved.