Package com.google.cloud.discoveryengine.v1beta

Class SearchResponse.GuidedSearchResult

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult

All Implemented Interfaces:

SearchResponse.GuidedSearchResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchResponse

public static final class SearchResponse.GuidedSearchResult
extends com.google.protobuf.GeneratedMessage
implements SearchResponse.GuidedSearchResultOrBuilder

 Guided search result. The guided search helps user to refine the search
 results and narrow down to the real needs from a broaded search results.
 

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SearchResponse.GuidedSearchResult.Builder	Guided search result.
static final class	SearchResponse.GuidedSearchResult.RefinementAttribute	Useful attribute for search result refinements.
static interface	SearchResponse.GuidedSearchResult.RefinementAttributeOrBuilder

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

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessage.BuilderParent

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FOLLOW_UP_QUESTIONS_FIELD_NUMBER
static final int	REFINEMENT_ATTRIBUTES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, 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	Description
boolean	equals(Object obj)
static SearchResponse.GuidedSearchResult	getDefaultInstance()
SearchResponse.GuidedSearchResult	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFollowUpQuestions(int index)	Suggested follow-up questions.
com.google.protobuf.ByteString	getFollowUpQuestionsBytes(int index)	Suggested follow-up questions.
int	getFollowUpQuestionsCount()	Suggested follow-up questions.
com.google.protobuf.ProtocolStringList	getFollowUpQuestionsList()	Suggested follow-up questions.
com.google.protobuf.Parser<SearchResponse.GuidedSearchResult>	getParserForType()
SearchResponse.GuidedSearchResult.RefinementAttribute	getRefinementAttributes(int index)	A list of ranked refinement attributes.
int	getRefinementAttributesCount()	A list of ranked refinement attributes.
List<SearchResponse.GuidedSearchResult.RefinementAttribute>	getRefinementAttributesList()	A list of ranked refinement attributes.
SearchResponse.GuidedSearchResult.RefinementAttributeOrBuilder	getRefinementAttributesOrBuilder(int index)	A list of ranked refinement attributes.
List<? extends SearchResponse.GuidedSearchResult.RefinementAttributeOrBuilder>	getRefinementAttributesOrBuilderList()	A list of ranked refinement attributes.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static SearchResponse.GuidedSearchResult.Builder	newBuilder()
static SearchResponse.GuidedSearchResult.Builder	newBuilder(SearchResponse.GuidedSearchResult prototype)
SearchResponse.GuidedSearchResult.Builder	newBuilderForType()
protected SearchResponse.GuidedSearchResult.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static SearchResponse.GuidedSearchResult	parseDelimitedFrom(InputStream input)
static SearchResponse.GuidedSearchResult	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.GuidedSearchResult	parseFrom(byte[] data)
static SearchResponse.GuidedSearchResult	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.GuidedSearchResult	parseFrom(com.google.protobuf.ByteString data)
static SearchResponse.GuidedSearchResult	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.GuidedSearchResult	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchResponse.GuidedSearchResult	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.GuidedSearchResult	parseFrom(InputStream input)
static SearchResponse.GuidedSearchResult	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.GuidedSearchResult	parseFrom(ByteBuffer data)
static SearchResponse.GuidedSearchResult	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchResponse.GuidedSearchResult>	parser()
SearchResponse.GuidedSearchResult.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

REFINEMENT_ATTRIBUTES_FIELD_NUMBER

public static final int REFINEMENT_ATTRIBUTES_FIELD_NUMBER

See Also:

• Constant Field Values

FOLLOW_UP_QUESTIONS_FIELD_NUMBER

public static final int FOLLOW_UP_QUESTIONS_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getRefinementAttributesList

public List<SearchResponse.GuidedSearchResult.RefinementAttribute> getRefinementAttributesList()

 A list of ranked refinement attributes.
 

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult.RefinementAttribute refinement_attributes = 1;

Specified by:

getRefinementAttributesList in interface SearchResponse.GuidedSearchResultOrBuilder

getRefinementAttributesOrBuilderList

public List<? extends SearchResponse.GuidedSearchResult.RefinementAttributeOrBuilder> getRefinementAttributesOrBuilderList()

 A list of ranked refinement attributes.
 

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult.RefinementAttribute refinement_attributes = 1;

Specified by:

getRefinementAttributesOrBuilderList in interface SearchResponse.GuidedSearchResultOrBuilder

getRefinementAttributesCount

public int getRefinementAttributesCount()

 A list of ranked refinement attributes.
 

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult.RefinementAttribute refinement_attributes = 1;

Specified by:

getRefinementAttributesCount in interface SearchResponse.GuidedSearchResultOrBuilder

getRefinementAttributes

public SearchResponse.GuidedSearchResult.RefinementAttribute getRefinementAttributes(int index)

 A list of ranked refinement attributes.
 

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult.RefinementAttribute refinement_attributes = 1;

Specified by:

getRefinementAttributes in interface SearchResponse.GuidedSearchResultOrBuilder

getRefinementAttributesOrBuilder

public SearchResponse.GuidedSearchResult.RefinementAttributeOrBuilder getRefinementAttributesOrBuilder(int index)

 A list of ranked refinement attributes.
 

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult.RefinementAttribute refinement_attributes = 1;

Specified by:

getRefinementAttributesOrBuilder in interface SearchResponse.GuidedSearchResultOrBuilder

getFollowUpQuestionsList

public com.google.protobuf.ProtocolStringList getFollowUpQuestionsList()

 Suggested follow-up questions.
 

repeated string follow_up_questions = 2;

Specified by:

getFollowUpQuestionsList in interface SearchResponse.GuidedSearchResultOrBuilder

Returns:

A list containing the followUpQuestions.

getFollowUpQuestionsCount

public int getFollowUpQuestionsCount()

 Suggested follow-up questions.
 

repeated string follow_up_questions = 2;

Specified by:

getFollowUpQuestionsCount in interface SearchResponse.GuidedSearchResultOrBuilder

Returns:

The count of followUpQuestions.

getFollowUpQuestions

public String getFollowUpQuestions(int index)

 Suggested follow-up questions.
 

repeated string follow_up_questions = 2;

Specified by:

getFollowUpQuestions in interface SearchResponse.GuidedSearchResultOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The followUpQuestions at the given index.

getFollowUpQuestionsBytes

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

 Suggested follow-up questions.
 

repeated string follow_up_questions = 2;

Specified by:

getFollowUpQuestionsBytes in interface SearchResponse.GuidedSearchResultOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the followUpQuestions 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.GeneratedMessage

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.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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 SearchResponse.GuidedSearchResult parseFrom(ByteBuffer data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.GuidedSearchResult parseFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static SearchResponse.GuidedSearchResult parseDelimitedFrom(InputStream input)
                                                            throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public SearchResponse.GuidedSearchResult.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchResponse.GuidedSearchResult.Builder newBuilder()

newBuilder

public static SearchResponse.GuidedSearchResult.Builder newBuilder(SearchResponse.GuidedSearchResult prototype)

toBuilder

public SearchResponse.GuidedSearchResult.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchResponse.GuidedSearchResult.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static SearchResponse.GuidedSearchResult getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<SearchResponse.GuidedSearchResult> 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.GeneratedMessage

getDefaultInstanceForType

public SearchResponse.GuidedSearchResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder