Class SearchResponse.GuidedSearchResult.Builder (0.50.0)

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

Static Methods

getDescriptor()

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

Methods

addAllFollowUpQuestions(Iterable<String> values)

public SearchResponse.GuidedSearchResult.Builder addAllFollowUpQuestions(Iterable<String> values)

Suggested follow-up questions.

repeated string follow_up_questions = 2;

Parameter
Name Description
values Iterable<String>

The followUpQuestions to add.

Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

This builder for chaining.

addAllRefinementAttributes(Iterable<? extends SearchResponse.GuidedSearchResult.RefinementAttribute> values)

public SearchResponse.GuidedSearchResult.Builder addAllRefinementAttributes(Iterable<? extends SearchResponse.GuidedSearchResult.RefinementAttribute> values)

A list of ranked refinement attributes.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult.RefinementAttribute>
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

addFollowUpQuestions(String value)

public SearchResponse.GuidedSearchResult.Builder addFollowUpQuestions(String value)

Suggested follow-up questions.

repeated string follow_up_questions = 2;

Parameter
Name Description
value String

The followUpQuestions to add.

Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

This builder for chaining.

addFollowUpQuestionsBytes(ByteString value)

public SearchResponse.GuidedSearchResult.Builder addFollowUpQuestionsBytes(ByteString value)

Suggested follow-up questions.

repeated string follow_up_questions = 2;

Parameter
Name Description
value ByteString

The bytes of the followUpQuestions to add.

Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

This builder for chaining.

addRefinementAttributes(SearchResponse.GuidedSearchResult.RefinementAttribute value)

public SearchResponse.GuidedSearchResult.Builder addRefinementAttributes(SearchResponse.GuidedSearchResult.RefinementAttribute value)

A list of ranked refinement attributes.

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

Parameter
Name Description
value SearchResponse.GuidedSearchResult.RefinementAttribute
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

addRefinementAttributes(SearchResponse.GuidedSearchResult.RefinementAttribute.Builder builderForValue)

public SearchResponse.GuidedSearchResult.Builder addRefinementAttributes(SearchResponse.GuidedSearchResult.RefinementAttribute.Builder builderForValue)

A list of ranked refinement attributes.

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

Parameter
Name Description
builderForValue SearchResponse.GuidedSearchResult.RefinementAttribute.Builder
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

addRefinementAttributes(int index, SearchResponse.GuidedSearchResult.RefinementAttribute value)

public SearchResponse.GuidedSearchResult.Builder addRefinementAttributes(int index, SearchResponse.GuidedSearchResult.RefinementAttribute value)

A list of ranked refinement attributes.

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

Parameters
Name Description
index int
value SearchResponse.GuidedSearchResult.RefinementAttribute
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

addRefinementAttributes(int index, SearchResponse.GuidedSearchResult.RefinementAttribute.Builder builderForValue)

public SearchResponse.GuidedSearchResult.Builder addRefinementAttributes(int index, SearchResponse.GuidedSearchResult.RefinementAttribute.Builder builderForValue)

A list of ranked refinement attributes.

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

Parameters
Name Description
index int
builderForValue SearchResponse.GuidedSearchResult.RefinementAttribute.Builder
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

addRefinementAttributesBuilder()

public SearchResponse.GuidedSearchResult.RefinementAttribute.Builder addRefinementAttributesBuilder()

A list of ranked refinement attributes.

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

Returns
Type Description
SearchResponse.GuidedSearchResult.RefinementAttribute.Builder

addRefinementAttributesBuilder(int index)

public SearchResponse.GuidedSearchResult.RefinementAttribute.Builder addRefinementAttributesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.GuidedSearchResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder
Overrides

build()

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

buildPartial()

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

clear()

public SearchResponse.GuidedSearchResult.Builder clear()
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchResponse.GuidedSearchResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder
Overrides

clearFollowUpQuestions()

public SearchResponse.GuidedSearchResult.Builder clearFollowUpQuestions()

Suggested follow-up questions.

repeated string follow_up_questions = 2;

Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchResponse.GuidedSearchResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder
Overrides

clearRefinementAttributes()

public SearchResponse.GuidedSearchResult.Builder clearRefinementAttributes()

A list of ranked refinement attributes.

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

Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

clone()

public SearchResponse.GuidedSearchResult.Builder clone()
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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

getRefinementAttributesBuilder(int index)

public SearchResponse.GuidedSearchResult.RefinementAttribute.Builder getRefinementAttributesBuilder(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.Builder

getRefinementAttributesBuilderList()

public List<SearchResponse.GuidedSearchResult.RefinementAttribute.Builder> getRefinementAttributesBuilderList()

A list of ranked refinement attributes.

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

Returns
Type Description
List<Builder>

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>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchResponse.GuidedSearchResult other)

public SearchResponse.GuidedSearchResult.Builder mergeFrom(SearchResponse.GuidedSearchResult other)
Parameter
Name Description
other SearchResponse.GuidedSearchResult
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchResponse.GuidedSearchResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchResponse.GuidedSearchResult.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.GuidedSearchResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder
Overrides

removeRefinementAttributes(int index)

public SearchResponse.GuidedSearchResult.Builder removeRefinementAttributes(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.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.GuidedSearchResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder
Overrides

setFollowUpQuestions(int index, String value)

public SearchResponse.GuidedSearchResult.Builder setFollowUpQuestions(int index, String value)

Suggested follow-up questions.

repeated string follow_up_questions = 2;

Parameters
Name Description
index int

The index to set the value at.

value String

The followUpQuestions to set.

Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

This builder for chaining.

setRefinementAttributes(int index, SearchResponse.GuidedSearchResult.RefinementAttribute value)

public SearchResponse.GuidedSearchResult.Builder setRefinementAttributes(int index, SearchResponse.GuidedSearchResult.RefinementAttribute value)

A list of ranked refinement attributes.

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

Parameters
Name Description
index int
value SearchResponse.GuidedSearchResult.RefinementAttribute
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

setRefinementAttributes(int index, SearchResponse.GuidedSearchResult.RefinementAttribute.Builder builderForValue)

public SearchResponse.GuidedSearchResult.Builder setRefinementAttributes(int index, SearchResponse.GuidedSearchResult.RefinementAttribute.Builder builderForValue)

A list of ranked refinement attributes.

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

Parameters
Name Description
index int
builderForValue SearchResponse.GuidedSearchResult.RefinementAttribute.Builder
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchResponse.GuidedSearchResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.GuidedSearchResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchResponse.GuidedSearchResult.Builder
Overrides