Class SearchResponse.GuidedSearchResult (0.40.0) 

public static final class SearchResponse.GuidedSearchResult extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchResponse.GuidedSearchResult

Static Fields

FOLLOW_UP_QUESTIONS_FIELD_NUMBER

public static final int FOLLOW_UP_QUESTIONS_FIELD_NUMBER
Field Value
Type Description
int

REFINEMENT_ATTRIBUTES_FIELD_NUMBER

public static final int REFINEMENT_ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchResponse.GuidedSearchResult getDefaultInstance()
Returns
Type Description
SearchResponse.GuidedSearchResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchResponse.GuidedSearchResult.Builder newBuilder()
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

newBuilder(SearchResponse.GuidedSearchResult prototype)

public static SearchResponse.GuidedSearchResult.Builder newBuilder(SearchResponse.GuidedSearchResult prototype)
Parameter
Name Description
prototype SearchResponse.GuidedSearchResult
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse.GuidedSearchResult parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.GuidedSearchResult
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.GuidedSearchResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.GuidedSearchResult
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchResponse.GuidedSearchResult parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchResponse.GuidedSearchResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.GuidedSearchResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.GuidedSearchResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchResponse.GuidedSearchResult parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchResponse.GuidedSearchResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.GuidedSearchResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.GuidedSearchResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchResponse.GuidedSearchResult parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchResponse.GuidedSearchResult
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.GuidedSearchResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.GuidedSearchResult
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchResponse.GuidedSearchResult parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.GuidedSearchResult
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.GuidedSearchResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.GuidedSearchResult
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchResponse.GuidedSearchResult parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchResponse.GuidedSearchResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.GuidedSearchResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.GuidedSearchResult
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchResponse.GuidedSearchResult> parser()
Returns
Type Description
Parser<GuidedSearchResult>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchResponse.GuidedSearchResult getDefaultInstanceForType()
Returns
Type Description
SearchResponse.GuidedSearchResult

getFollowUpQuestions(int index)

public String getFollowUpQuestions(int index)

Suggested follow-up questions.

repeated string follow_up_questions = 2;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The followUpQuestions at the given index.

getFollowUpQuestionsBytes(int index)

public ByteString getFollowUpQuestionsBytes(int index)

Suggested follow-up questions.

repeated string follow_up_questions = 2;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the followUpQuestions at the given index.

getFollowUpQuestionsCount()

public int getFollowUpQuestionsCount()

Suggested follow-up questions.

repeated string follow_up_questions = 2;

Returns
Type Description
int

The count of followUpQuestions.

getFollowUpQuestionsList()

public ProtocolStringList getFollowUpQuestionsList()

Suggested follow-up questions.

repeated string follow_up_questions = 2;

Returns
Type Description
ProtocolStringList

A list containing the followUpQuestions.

getParserForType()

public Parser<SearchResponse.GuidedSearchResult> getParserForType()
Returns
Type Description
Parser<GuidedSearchResult>
Overrides

getRefinementAttributes(int index)

public SearchResponse.GuidedSearchResult.RefinementAttribute getRefinementAttributes(int index)

A list of ranked refinement attributes.

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

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.GuidedSearchResult.RefinementAttribute

getRefinementAttributesCount()

public int getRefinementAttributesCount()

A list of ranked refinement attributes.

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

Returns
Type Description
int

getRefinementAttributesList()

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

A list of ranked refinement attributes.

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

Returns
Type Description
List<RefinementAttribute>

getRefinementAttributesOrBuilder(int index)

public SearchResponse.GuidedSearchResult.RefinementAttributeOrBuilder getRefinementAttributesOrBuilder(int index)

A list of ranked refinement attributes.

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

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.GuidedSearchResult.RefinementAttributeOrBuilder

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;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult.RefinementAttributeOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchResponse.GuidedSearchResult.Builder newBuilderForType()
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchResponse.GuidedSearchResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchResponse.GuidedSearchResult.Builder toBuilder()
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException