Package com.google.cloud.discoveryengine.v1beta

Class RecommendResponse.RecommendationResult.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>

com.google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.Builder

All Implemented Interfaces:

RecommendResponse.RecommendationResultOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

RecommendResponse.RecommendationResult

public static final class RecommendResponse.RecommendationResult.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>
implements RecommendResponse.RecommendationResultOrBuilder

 RecommendationResult represents a generic recommendation result with
 associated metadata.
 

Protobuf type google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult

Method Summary

Modifier and Type	Method	Description
RecommendResponse.RecommendationResult.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RecommendResponse.RecommendationResult	build()
RecommendResponse.RecommendationResult	buildPartial()
RecommendResponse.RecommendationResult.Builder	clear()
RecommendResponse.RecommendationResult.Builder	clearDocument()	Set if `returnDocument` is set to true in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
RecommendResponse.RecommendationResult.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RecommendResponse.RecommendationResult.Builder	clearId()	Resource ID of the recommended Document.
RecommendResponse.RecommendationResult.Builder	clearMetadata()
RecommendResponse.RecommendationResult.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RecommendResponse.RecommendationResult.Builder	clone()
boolean	containsMetadata(String key)	Additional Document metadata / annotations.
RecommendResponse.RecommendationResult	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Document	getDocument()	Set if `returnDocument` is set to true in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
Document.Builder	getDocumentBuilder()	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.
Map<String,com.google.protobuf.Value>	getMutableMetadata()	Deprecated.
boolean	hasDocument()	Set if `returnDocument` is set to true in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
protected com.google.protobuf.MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
RecommendResponse.RecommendationResult.Builder	mergeDocument(Document value)	Set if `returnDocument` is set to true in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
RecommendResponse.RecommendationResult.Builder	mergeFrom(RecommendResponse.RecommendationResult other)
RecommendResponse.RecommendationResult.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RecommendResponse.RecommendationResult.Builder	mergeFrom(com.google.protobuf.Message other)
RecommendResponse.RecommendationResult.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RecommendResponse.RecommendationResult.Builder	putAllMetadata(Map<String,com.google.protobuf.Value> values)	Additional Document metadata / annotations.
RecommendResponse.RecommendationResult.Builder	putMetadata(String key, com.google.protobuf.Value value)	Additional Document metadata / annotations.
RecommendResponse.RecommendationResult.Builder	removeMetadata(String key)	Additional Document metadata / annotations.
RecommendResponse.RecommendationResult.Builder	setDocument(Document value)	Set if `returnDocument` is set to true in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
RecommendResponse.RecommendationResult.Builder	setDocument(Document.Builder builderForValue)	Set if `returnDocument` is set to true in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
RecommendResponse.RecommendationResult.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RecommendResponse.RecommendationResult.Builder	setId(String value)	Resource ID of the recommended Document.
RecommendResponse.RecommendationResult.Builder	setIdBytes(com.google.protobuf.ByteString value)	Resource ID of the recommended Document.
RecommendResponse.RecommendationResult.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RecommendResponse.RecommendationResult.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

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.Builder<RecommendResponse.RecommendationResult.Builder>

internalGetMutableMapField

protected com.google.protobuf.MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>

clear

public RecommendResponse.RecommendationResult.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>

getDefaultInstanceForType

public RecommendResponse.RecommendationResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RecommendResponse.RecommendationResult build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RecommendResponse.RecommendationResult buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public RecommendResponse.RecommendationResult.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>

setField

public RecommendResponse.RecommendationResult.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                               Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>

clearField

public RecommendResponse.RecommendationResult.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>

clearOneof

public RecommendResponse.RecommendationResult.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>

setRepeatedField

public RecommendResponse.RecommendationResult.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                       int index,
                                                                       Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>

addRepeatedField

public RecommendResponse.RecommendationResult.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                       Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>

mergeFrom

public RecommendResponse.RecommendationResult.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RecommendResponse.RecommendationResult.Builder>

mergeFrom

public RecommendResponse.RecommendationResult.Builder mergeFrom(RecommendResponse.RecommendationResult other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>

mergeFrom

public RecommendResponse.RecommendationResult.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RecommendResponse.RecommendationResult.Builder>

Throws:

IOException

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.

setId

public RecommendResponse.RecommendationResult.Builder setId(String value)

 Resource ID of the recommended Document.
 

string id = 1;

Parameters:

value - The id to set.

Returns:

This builder for chaining.

clearId

public RecommendResponse.RecommendationResult.Builder clearId()

 Resource ID of the recommended Document.
 

string id = 1;

Returns:

This builder for chaining.

setIdBytes

public RecommendResponse.RecommendationResult.Builder setIdBytes(com.google.protobuf.ByteString value)

 Resource ID of the recommended Document.
 

string id = 1;

Parameters:

value - The bytes for id to set.

Returns:

This builder for chaining.

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.

setDocument

public RecommendResponse.RecommendationResult.Builder setDocument(Document value)

 Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

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

setDocument

public RecommendResponse.RecommendationResult.Builder setDocument(Document.Builder builderForValue)

 Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

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

mergeDocument

public RecommendResponse.RecommendationResult.Builder mergeDocument(Document value)

 Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

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

clearDocument

public RecommendResponse.RecommendationResult.Builder clearDocument()

 Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

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

getDocumentBuilder

public Document.Builder getDocumentBuilder()

 Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

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

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

getMetadataCount

public int getMetadataCount()

Description copied from interface: RecommendResponse.RecommendationResultOrBuilder

 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;

Specified by:

getMetadataCount in interface RecommendResponse.RecommendationResultOrBuilder

containsMetadata

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][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

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

Specified by:

containsMetadata in interface RecommendResponse.RecommendationResultOrBuilder

getMetadata

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

Deprecated.

Use getMetadataMap() instead.

Specified by:

getMetadata in interface RecommendResponse.RecommendationResultOrBuilder

getMetadataMap

public 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;

Specified by:

getMetadataMap in interface RecommendResponse.RecommendationResultOrBuilder

getMetadataOrDefault

public 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;

Specified by:

getMetadataOrDefault in interface RecommendResponse.RecommendationResultOrBuilder

getMetadataOrThrow

public 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;

Specified by:

getMetadataOrThrow in interface RecommendResponse.RecommendationResultOrBuilder

clearMetadata

public RecommendResponse.RecommendationResult.Builder clearMetadata()

removeMetadata

public RecommendResponse.RecommendationResult.Builder removeMetadata(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;

getMutableMetadata

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

Deprecated.

Use alternate mutation accessors instead.

putMetadata

public RecommendResponse.RecommendationResult.Builder putMetadata(String key,
                                                                  com.google.protobuf.Value value)

 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;

putAllMetadata

public RecommendResponse.RecommendationResult.Builder putAllMetadata(Map<String,com.google.protobuf.Value> values)

 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;

setUnknownFields

public final RecommendResponse.RecommendationResult.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>

mergeUnknownFields

public final RecommendResponse.RecommendationResult.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RecommendResponse.RecommendationResult.Builder>