public static final class CompletionSuggestion.Builder extends GeneratedMessageV3.Builder<CompletionSuggestion.Builder> implements CompletionSuggestionOrBuilderAutocomplete 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.BuilderImplements
CompletionSuggestionOrBuilderStatic 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 |
StringThe 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 |
ByteStringThe 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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
getAlternativePhrases(int index)
public String getAlternativePhrases(int index)Alternative matching phrases for this suggestion.
repeated string alternative_phrases = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe 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 |
intThe 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 |
|
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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CompletionSuggestion.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CompletionSuggestion.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CompletionSuggestion.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CompletionSuggestion.Builder |
|
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 |
intThe index to set the value at. |
value |
StringThe 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 |
|
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 |
longThe 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 |
doubleThe 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 |
StringThe 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 |
ByteStringThe 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 |
doubleThe 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 |
StringThe 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 |
ByteStringThe 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 |
|
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 |
StringThe 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 |
ByteStringThe 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 |
|