Class CompletionSuggestion.Builder (0.44.0)

Version 0.44.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 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 final class CompletionSuggestion.Builder extends GeneratedMessageV3.Builder<CompletionSuggestion.Builder> implements CompletionSuggestionOrBuilder

Autocomplete suggestions that are imported from Customer.

Protobuf type google.cloud.discoveryengine.v1alpha.CompletionSuggestion

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CompletionSuggestion.Builder

Implements

CompletionSuggestionOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllAlternativePhrases(Iterable<String> values)

public CompletionSuggestion.Builder addAllAlternativePhrases(Iterable<String> values)

Alternative matching phrases for this suggestion.

repeated string alternative_phrases = 7;

Parameter
Name	Description
values	Iterable<String> The alternativePhrases to add.

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

addAlternativePhrases(String value)

public CompletionSuggestion.Builder addAlternativePhrases(String value)

Alternative matching phrases for this suggestion.

repeated string alternative_phrases = 7;

Parameter
Name	Description
value	String The alternativePhrases to add.

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

addAlternativePhrasesBytes(ByteString value)

public CompletionSuggestion.Builder addAlternativePhrasesBytes(ByteString value)

Alternative matching phrases for this suggestion.

repeated string alternative_phrases = 7;

Parameter
Name	Description
value	ByteString The bytes of the alternativePhrases to add.

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CompletionSuggestion.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CompletionSuggestion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CompletionSuggestion build()

Returns
Type	Description
CompletionSuggestion

buildPartial()

public CompletionSuggestion buildPartial()

Returns
Type	Description
CompletionSuggestion

clear()

public CompletionSuggestion.Builder clear()

Returns
Type	Description
CompletionSuggestion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAlternativePhrases()

public CompletionSuggestion.Builder clearAlternativePhrases()

Alternative matching phrases for this suggestion.

repeated string alternative_phrases = 7;

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CompletionSuggestion.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
CompletionSuggestion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFrequency()

public CompletionSuggestion.Builder clearFrequency()

Frequency of this suggestion. Will be used to rank suggestions when score is not available.

int64 frequency = 3;

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

clearGlobalScore()

public CompletionSuggestion.Builder clearGlobalScore()

Global score of this suggestion. Control how this suggestion would be scored / ranked.

double global_score = 2;

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

clearGroupId()

public CompletionSuggestion.Builder clearGroupId()

If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.

string group_id = 5;

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

clearGroupScore()

public CompletionSuggestion.Builder clearGroupScore()

The score of this suggestion within its group.

double group_score = 6;

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

clearLanguageCode()

public CompletionSuggestion.Builder clearLanguageCode()

BCP-47 language code of this suggestion.

string language_code = 4;

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CompletionSuggestion.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
CompletionSuggestion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRankingInfo()

public CompletionSuggestion.Builder clearRankingInfo()

Returns
Type	Description
CompletionSuggestion.Builder

clearSuggestion()

public CompletionSuggestion.Builder clearSuggestion()

Required. The suggestion text.

string suggestion = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

clone()

public CompletionSuggestion.Builder clone()

Returns
Type	Description
CompletionSuggestion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAlternativePhrases(int index)

public String getAlternativePhrases(int index)

Alternative matching phrases for this suggestion.

repeated string alternative_phrases = 7;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The alternativePhrases at the given index.

getAlternativePhrasesBytes(int index)

public ByteString getAlternativePhrasesBytes(int index)

Alternative matching phrases for this suggestion.

repeated string alternative_phrases = 7;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the alternativePhrases at the given index.

getAlternativePhrasesCount()

public int getAlternativePhrasesCount()

Alternative matching phrases for this suggestion.

repeated string alternative_phrases = 7;

Returns
Type	Description
int	The count of alternativePhrases.

getAlternativePhrasesList()

public ProtocolStringList getAlternativePhrasesList()

Alternative matching phrases for this suggestion.

repeated string alternative_phrases = 7;

Returns
Type	Description
ProtocolStringList	A list containing the alternativePhrases.

getDefaultInstanceForType()

public CompletionSuggestion getDefaultInstanceForType()

Returns
Type	Description
CompletionSuggestion

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFrequency()

public long getFrequency()

Frequency of this suggestion. Will be used to rank suggestions when score is not available.

int64 frequency = 3;

Returns
Type	Description
long	The frequency.

getGlobalScore()

public double getGlobalScore()

Global score of this suggestion. Control how this suggestion would be scored / ranked.

double global_score = 2;

Returns
Type	Description
double	The globalScore.

getGroupId()

public String getGroupId()

If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.

string group_id = 5;

Returns
Type	Description
String	The groupId.

getGroupIdBytes()

public ByteString getGroupIdBytes()

If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.

string group_id = 5;

Returns
Type	Description
ByteString	The bytes for groupId.

getGroupScore()

public double getGroupScore()

The score of this suggestion within its group.

double group_score = 6;

Returns
Type	Description
double	The groupScore.

getLanguageCode()

public String getLanguageCode()

BCP-47 language code of this suggestion.

string language_code = 4;

Returns
Type	Description
String	The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

BCP-47 language code of this suggestion.

string language_code = 4;

Returns
Type	Description
ByteString	The bytes for languageCode.

getRankingInfoCase()

public CompletionSuggestion.RankingInfoCase getRankingInfoCase()

Returns
Type	Description
CompletionSuggestion.RankingInfoCase

getSuggestion()

public String getSuggestion()

Required. The suggestion text.

string suggestion = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The suggestion.

getSuggestionBytes()

public ByteString getSuggestionBytes()

Required. The suggestion text.

string suggestion = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for suggestion.

hasFrequency()

public boolean hasFrequency()

Frequency of this suggestion. Will be used to rank suggestions when score is not available.

int64 frequency = 3;

Returns
Type	Description
boolean	Whether the frequency field is set.

hasGlobalScore()

public boolean hasGlobalScore()

Global score of this suggestion. Control how this suggestion would be scored / ranked.

double global_score = 2;

Returns
Type	Description
boolean	Whether the globalScore field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CompletionSuggestion other)

public CompletionSuggestion.Builder mergeFrom(CompletionSuggestion other)

Parameter
Name	Description
other	CompletionSuggestion

Returns
Type	Description
CompletionSuggestion.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CompletionSuggestion.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CompletionSuggestion.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CompletionSuggestion.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CompletionSuggestion.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompletionSuggestion.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CompletionSuggestion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAlternativePhrases(int index, String value)

public CompletionSuggestion.Builder setAlternativePhrases(int index, String value)

Alternative matching phrases for this suggestion.

repeated string alternative_phrases = 7;

Parameters
Name	Description
index	int The index to set the value at.
value	String The alternativePhrases to set.

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CompletionSuggestion.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CompletionSuggestion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFrequency(long value)

public CompletionSuggestion.Builder setFrequency(long value)

Frequency of this suggestion. Will be used to rank suggestions when score is not available.

int64 frequency = 3;

Parameter
Name	Description
value	long The frequency to set.

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

setGlobalScore(double value)

public CompletionSuggestion.Builder setGlobalScore(double value)

Global score of this suggestion. Control how this suggestion would be scored / ranked.

double global_score = 2;

Parameter
Name	Description
value	double The globalScore to set.

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

setGroupId(String value)

public CompletionSuggestion.Builder setGroupId(String value)

If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.

string group_id = 5;

Parameter
Name	Description
value	String The groupId to set.

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

setGroupIdBytes(ByteString value)

public CompletionSuggestion.Builder setGroupIdBytes(ByteString value)

If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.

string group_id = 5;

Parameter
Name	Description
value	ByteString The bytes for groupId to set.

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

setGroupScore(double value)

public CompletionSuggestion.Builder setGroupScore(double value)

The score of this suggestion within its group.

double group_score = 6;

Parameter
Name	Description
value	double The groupScore to set.

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

setLanguageCode(String value)

public CompletionSuggestion.Builder setLanguageCode(String value)

BCP-47 language code of this suggestion.

string language_code = 4;

Parameter
Name	Description
value	String The languageCode to set.

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

setLanguageCodeBytes(ByteString value)

public CompletionSuggestion.Builder setLanguageCodeBytes(ByteString value)

BCP-47 language code of this suggestion.

string language_code = 4;

Parameter
Name	Description
value	ByteString The bytes for languageCode to set.

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CompletionSuggestion.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
CompletionSuggestion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSuggestion(String value)

public CompletionSuggestion.Builder setSuggestion(String value)

Required. The suggestion text.

string suggestion = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The suggestion to set.

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

setSuggestionBytes(ByteString value)

public CompletionSuggestion.Builder setSuggestionBytes(ByteString value)

Required. The suggestion text.

string suggestion = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for suggestion to set.

Returns
Type	Description
CompletionSuggestion.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CompletionSuggestion.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CompletionSuggestion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)