com.google.cloud.discoveryengine.v1alpha

Class CompletionSuggestion

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.CompletionSuggestion

All Implemented Interfaces:

CompletionSuggestionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class CompletionSuggestion
extends com.google.protobuf.GeneratedMessageV3
implements CompletionSuggestionOrBuilder

 Autocomplete suggestions that are imported from Customer.
 

Protobuf type google.cloud.discoveryengine.v1alpha.CompletionSuggestion

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompletionSuggestion.Builder Autocomplete suggestions that are imported from Customer.
static class	CompletionSuggestion.RankingInfoCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALTERNATIVE_PHRASES_FIELD_NUMBER
static int	FREQUENCY_FIELD_NUMBER
static int	GLOBAL_SCORE_FIELD_NUMBER
static int	GROUP_ID_FIELD_NUMBER
static int	GROUP_SCORE_FIELD_NUMBER
static int	LANGUAGE_CODE_FIELD_NUMBER
static int	SUGGESTION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAlternativePhrases(int index) Alternative matching phrases for this suggestion.
com.google.protobuf.ByteString	getAlternativePhrasesBytes(int index) Alternative matching phrases for this suggestion.
int	getAlternativePhrasesCount() Alternative matching phrases for this suggestion.
com.google.protobuf.ProtocolStringList	getAlternativePhrasesList() Alternative matching phrases for this suggestion.
static CompletionSuggestion	getDefaultInstance()
CompletionSuggestion	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
long	getFrequency() Frequency of this suggestion.
double	getGlobalScore() Global score of this suggestion.
String	getGroupId() If two suggestions have the same groupId, they will not be returned together.
com.google.protobuf.ByteString	getGroupIdBytes() If two suggestions have the same groupId, they will not be returned together.
double	getGroupScore() The score of this suggestion within its group.
String	getLanguageCode() BCP-47 language code of this suggestion.
com.google.protobuf.ByteString	getLanguageCodeBytes() BCP-47 language code of this suggestion.
com.google.protobuf.Parser<CompletionSuggestion>	getParserForType()
CompletionSuggestion.RankingInfoCase	getRankingInfoCase()
int	getSerializedSize()
String	getSuggestion() Required.
com.google.protobuf.ByteString	getSuggestionBytes() Required.
boolean	hasFrequency() Frequency of this suggestion.
boolean	hasGlobalScore() Global score of this suggestion.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CompletionSuggestion.Builder	newBuilder()
static CompletionSuggestion.Builder	newBuilder(CompletionSuggestion prototype)
CompletionSuggestion.Builder	newBuilderForType()
protected CompletionSuggestion.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CompletionSuggestion	parseDelimitedFrom(InputStream input)
static CompletionSuggestion	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CompletionSuggestion	parseFrom(byte[] data)
static CompletionSuggestion	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CompletionSuggestion	parseFrom(ByteBuffer data)
static CompletionSuggestion	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CompletionSuggestion	parseFrom(com.google.protobuf.ByteString data)
static CompletionSuggestion	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CompletionSuggestion	parseFrom(com.google.protobuf.CodedInputStream input)
static CompletionSuggestion	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CompletionSuggestion	parseFrom(InputStream input)
static CompletionSuggestion	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CompletionSuggestion>	parser()
CompletionSuggestion.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

GLOBAL_SCORE_FIELD_NUMBER

public static final int GLOBAL_SCORE_FIELD_NUMBER

See Also:

Constant Field Values

FREQUENCY_FIELD_NUMBER

public static final int FREQUENCY_FIELD_NUMBER

See Also:

Constant Field Values

SUGGESTION_FIELD_NUMBER

public static final int SUGGESTION_FIELD_NUMBER

See Also:

Constant Field Values

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER

See Also:

Constant Field Values

GROUP_ID_FIELD_NUMBER

public static final int GROUP_ID_FIELD_NUMBER

See Also:

Constant Field Values

GROUP_SCORE_FIELD_NUMBER

public static final int GROUP_SCORE_FIELD_NUMBER

See Also:

Constant Field Values

ALTERNATIVE_PHRASES_FIELD_NUMBER

public static final int ALTERNATIVE_PHRASES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getRankingInfoCase

public CompletionSuggestion.RankingInfoCase getRankingInfoCase()

Specified by:

getRankingInfoCase in interface CompletionSuggestionOrBuilder

hasGlobalScore

public boolean hasGlobalScore()

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

double global_score = 2;

Specified by:

hasGlobalScore in interface CompletionSuggestionOrBuilder

Returns:

Whether the globalScore field is set.

getGlobalScore

public double getGlobalScore()

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

double global_score = 2;

Specified by:

getGlobalScore in interface CompletionSuggestionOrBuilder

Returns:

The globalScore.

hasFrequency

public boolean hasFrequency()

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

int64 frequency = 3;

Specified by:

hasFrequency in interface CompletionSuggestionOrBuilder

Returns:

Whether the frequency field is set.

getFrequency

public long getFrequency()

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

int64 frequency = 3;

Specified by:

getFrequency in interface CompletionSuggestionOrBuilder

Returns:

The frequency.

getSuggestion

public String getSuggestion()

 Required. The suggestion text.
 

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

Specified by:

getSuggestion in interface CompletionSuggestionOrBuilder

Returns:

The suggestion.

getSuggestionBytes

public com.google.protobuf.ByteString getSuggestionBytes()

 Required. The suggestion text.
 

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

Specified by:

getSuggestionBytes in interface CompletionSuggestionOrBuilder

Returns:

The bytes for suggestion.

getLanguageCode

public String getLanguageCode()

 BCP-47 language code of this suggestion.
 

string language_code = 4;

Specified by:

getLanguageCode in interface CompletionSuggestionOrBuilder

Returns:

The languageCode.

getLanguageCodeBytes

public com.google.protobuf.ByteString getLanguageCodeBytes()

 BCP-47 language code of this suggestion.
 

string language_code = 4;

Specified by:

getLanguageCodeBytes in interface CompletionSuggestionOrBuilder

Returns:

The bytes for languageCode.

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;

Specified by:

getGroupId in interface CompletionSuggestionOrBuilder

Returns:

The groupId.

getGroupIdBytes

public com.google.protobuf.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;

Specified by:

getGroupIdBytes in interface CompletionSuggestionOrBuilder

Returns:

The bytes for groupId.

getGroupScore

public double getGroupScore()

 The score of this suggestion within its group.
 

double group_score = 6;

Specified by:

getGroupScore in interface CompletionSuggestionOrBuilder

Returns:

The groupScore.

getAlternativePhrasesList

public com.google.protobuf.ProtocolStringList getAlternativePhrasesList()

 Alternative matching phrases for this suggestion.
 

repeated string alternative_phrases = 7;

Specified by:

getAlternativePhrasesList in interface CompletionSuggestionOrBuilder

Returns:

A list containing the alternativePhrases.

getAlternativePhrasesCount

public int getAlternativePhrasesCount()

 Alternative matching phrases for this suggestion.
 

repeated string alternative_phrases = 7;

Specified by:

getAlternativePhrasesCount in interface CompletionSuggestionOrBuilder

Returns:

The count of alternativePhrases.

getAlternativePhrases

public String getAlternativePhrases(int index)

 Alternative matching phrases for this suggestion.
 

repeated string alternative_phrases = 7;

Specified by:

getAlternativePhrases in interface CompletionSuggestionOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The alternativePhrases at the given index.

getAlternativePhrasesBytes

public com.google.protobuf.ByteString getAlternativePhrasesBytes(int index)

 Alternative matching phrases for this suggestion.
 

repeated string alternative_phrases = 7;

Specified by:

getAlternativePhrasesBytes in interface CompletionSuggestionOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the alternativePhrases at the given index.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static CompletionSuggestion parseFrom(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CompletionSuggestion parseFrom(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CompletionSuggestion parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CompletionSuggestion parseFrom(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CompletionSuggestion parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CompletionSuggestion parseFrom(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CompletionSuggestion parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static CompletionSuggestion parseFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static CompletionSuggestion parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static CompletionSuggestion parseDelimitedFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseFrom

public static CompletionSuggestion parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static CompletionSuggestion parseFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

newBuilderForType

public CompletionSuggestion.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CompletionSuggestion.Builder newBuilder()

newBuilder

public static CompletionSuggestion.Builder newBuilder(CompletionSuggestion prototype)

toBuilder

public CompletionSuggestion.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected CompletionSuggestion.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CompletionSuggestion getDefaultInstance()

parser

public static com.google.protobuf.Parser<CompletionSuggestion> parser()

getParserForType

public com.google.protobuf.Parser<CompletionSuggestion> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public CompletionSuggestion getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder