Class CompletionSuggestion (0.49.0)

Version latest

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

Autocomplete suggestions that are imported from Customer.

Protobuf type google.cloud.discoveryengine.v1.CompletionSuggestion

Inheritance

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

Implements

CompletionSuggestionOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALTERNATIVE_PHRASES_FIELD_NUMBER

public static final int ALTERNATIVE_PHRASES_FIELD_NUMBER

Field Value
Type	Description
int

FREQUENCY_FIELD_NUMBER

public static final int FREQUENCY_FIELD_NUMBER

Field Value
Type	Description
int

GLOBAL_SCORE_FIELD_NUMBER

public static final int GLOBAL_SCORE_FIELD_NUMBER

Field Value
Type	Description
int

GROUP_ID_FIELD_NUMBER

public static final int GROUP_ID_FIELD_NUMBER

Field Value
Type	Description
int

GROUP_SCORE_FIELD_NUMBER

public static final int GROUP_SCORE_FIELD_NUMBER

Field Value
Type	Description
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER

Field Value
Type	Description
int

SUGGESTION_FIELD_NUMBER

public static final int SUGGESTION_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static CompletionSuggestion getDefaultInstance()

Returns
Type	Description
CompletionSuggestion

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static CompletionSuggestion.Builder newBuilder()

Returns
Type	Description
CompletionSuggestion.Builder

newBuilder(CompletionSuggestion prototype)

public static CompletionSuggestion.Builder newBuilder(CompletionSuggestion prototype)

Parameter
Name	Description
prototype	CompletionSuggestion

Returns
Type	Description
CompletionSuggestion.Builder

parseDelimitedFrom(InputStream input)

public static CompletionSuggestion parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
CompletionSuggestion

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompletionSuggestion parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CompletionSuggestion

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static CompletionSuggestion parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
CompletionSuggestion

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CompletionSuggestion parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CompletionSuggestion

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CompletionSuggestion parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
CompletionSuggestion

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CompletionSuggestion parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CompletionSuggestion

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CompletionSuggestion parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
CompletionSuggestion

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CompletionSuggestion parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CompletionSuggestion

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static CompletionSuggestion parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
CompletionSuggestion

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompletionSuggestion parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CompletionSuggestion

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static CompletionSuggestion parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
CompletionSuggestion

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CompletionSuggestion parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CompletionSuggestion

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<CompletionSuggestion> parser()

Returns
Type	Description
Parser<CompletionSuggestion>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

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.

getParserForType()

public Parser<CompletionSuggestion> getParserForType()

Returns
Type	Description
Parser<CompletionSuggestion>

Overrides

GeneratedMessageV3.getParserForType()

getRankingInfoCase()

public CompletionSuggestion.RankingInfoCase getRankingInfoCase()

Returns
Type	Description
CompletionSuggestion.RankingInfoCase

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public CompletionSuggestion.Builder newBuilderForType()

Returns
Type	Description
CompletionSuggestion.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CompletionSuggestion.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
CompletionSuggestion.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CompletionSuggestion.Builder toBuilder()

Returns
Type	Description
CompletionSuggestion.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException