Package com.google.cloud.discoveryengine.v1beta

Class SearchResponse.GuidedSearchResult.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.GuidedSearchResult.Builder>

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

All Implemented Interfaces:

SearchResponse.GuidedSearchResultOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SearchResponse.GuidedSearchResult

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

Method Summary

Modifier and Type	Method	Description
SearchResponse.GuidedSearchResult.Builder	addAllFollowUpQuestions(Iterable<String> values)	Suggested follow-up questions.
SearchResponse.GuidedSearchResult.Builder	addAllRefinementAttributes(Iterable<? extends SearchResponse.GuidedSearchResult.RefinementAttribute> values)	A list of ranked refinement attributes.
SearchResponse.GuidedSearchResult.Builder	addFollowUpQuestions(String value)	Suggested follow-up questions.
SearchResponse.GuidedSearchResult.Builder	addFollowUpQuestionsBytes(com.google.protobuf.ByteString value)	Suggested follow-up questions.
SearchResponse.GuidedSearchResult.Builder	addRefinementAttributes(int index, SearchResponse.GuidedSearchResult.RefinementAttribute value)	A list of ranked refinement attributes.
SearchResponse.GuidedSearchResult.Builder	addRefinementAttributes(int index, SearchResponse.GuidedSearchResult.RefinementAttribute.Builder builderForValue)	A list of ranked refinement attributes.
SearchResponse.GuidedSearchResult.Builder	addRefinementAttributes(SearchResponse.GuidedSearchResult.RefinementAttribute value)	A list of ranked refinement attributes.
SearchResponse.GuidedSearchResult.Builder	addRefinementAttributes(SearchResponse.GuidedSearchResult.RefinementAttribute.Builder builderForValue)	A list of ranked refinement attributes.
SearchResponse.GuidedSearchResult.RefinementAttribute.Builder	addRefinementAttributesBuilder()	A list of ranked refinement attributes.
SearchResponse.GuidedSearchResult.RefinementAttribute.Builder	addRefinementAttributesBuilder(int index)	A list of ranked refinement attributes.
SearchResponse.GuidedSearchResult.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchResponse.GuidedSearchResult	build()
SearchResponse.GuidedSearchResult	buildPartial()
SearchResponse.GuidedSearchResult.Builder	clear()
SearchResponse.GuidedSearchResult.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
SearchResponse.GuidedSearchResult.Builder	clearFollowUpQuestions()	Suggested follow-up questions.
SearchResponse.GuidedSearchResult.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
SearchResponse.GuidedSearchResult.Builder	clearRefinementAttributes()	A list of ranked refinement attributes.
SearchResponse.GuidedSearchResult.Builder	clone()
SearchResponse.GuidedSearchResult	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
SearchResponse.GuidedSearchResult.RefinementAttribute	getRefinementAttributes(int index)	A list of ranked refinement attributes.
SearchResponse.GuidedSearchResult.RefinementAttribute.Builder	getRefinementAttributesBuilder(int index)	A list of ranked refinement attributes.
List<SearchResponse.GuidedSearchResult.RefinementAttribute.Builder>	getRefinementAttributesBuilderList()	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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
SearchResponse.GuidedSearchResult.Builder	mergeFrom(SearchResponse.GuidedSearchResult other)
SearchResponse.GuidedSearchResult.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SearchResponse.GuidedSearchResult.Builder	mergeFrom(com.google.protobuf.Message other)
SearchResponse.GuidedSearchResult.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
SearchResponse.GuidedSearchResult.Builder	removeRefinementAttributes(int index)	A list of ranked refinement attributes.
SearchResponse.GuidedSearchResult.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchResponse.GuidedSearchResult.Builder	setFollowUpQuestions(int index, String value)	Suggested follow-up questions.
SearchResponse.GuidedSearchResult.Builder	setRefinementAttributes(int index, SearchResponse.GuidedSearchResult.RefinementAttribute value)	A list of ranked refinement attributes.
SearchResponse.GuidedSearchResult.Builder	setRefinementAttributes(int index, SearchResponse.GuidedSearchResult.RefinementAttribute.Builder builderForValue)	A list of ranked refinement attributes.
SearchResponse.GuidedSearchResult.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
SearchResponse.GuidedSearchResult.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

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

clear

public SearchResponse.GuidedSearchResult.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.GuidedSearchResult.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.GuidedSearchResult.Builder>

getDefaultInstanceForType

public SearchResponse.GuidedSearchResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public SearchResponse.GuidedSearchResult build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public SearchResponse.GuidedSearchResult buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public SearchResponse.GuidedSearchResult.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.GuidedSearchResult.Builder>

setField

public SearchResponse.GuidedSearchResult.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.GuidedSearchResult.Builder>

clearField

public SearchResponse.GuidedSearchResult.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.GuidedSearchResult.Builder>

clearOneof

public SearchResponse.GuidedSearchResult.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.GuidedSearchResult.Builder>

setRepeatedField

public SearchResponse.GuidedSearchResult.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                  int index,
                                                                  Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.GuidedSearchResult.Builder>

addRepeatedField

public SearchResponse.GuidedSearchResult.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                  Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.GuidedSearchResult.Builder>

mergeFrom

public SearchResponse.GuidedSearchResult.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchResponse.GuidedSearchResult.Builder>

mergeFrom

public SearchResponse.GuidedSearchResult.Builder mergeFrom(SearchResponse.GuidedSearchResult other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.GuidedSearchResult.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchResponse.GuidedSearchResult.Builder>

Throws:

IOException

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

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

setRefinementAttributes

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;

setRefinementAttributes

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;

addRefinementAttributes

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;

addRefinementAttributes

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;

addRefinementAttributes

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;

addRefinementAttributes

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;

addAllRefinementAttributes

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;

clearRefinementAttributes

public SearchResponse.GuidedSearchResult.Builder clearRefinementAttributes()

 A list of ranked refinement attributes.
 

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

removeRefinementAttributes

public SearchResponse.GuidedSearchResult.Builder removeRefinementAttributes(int index)

 A list of ranked refinement attributes.
 

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

getRefinementAttributesBuilder

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;

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

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

addRefinementAttributesBuilder

public SearchResponse.GuidedSearchResult.RefinementAttribute.Builder addRefinementAttributesBuilder()

 A list of ranked refinement attributes.
 

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

addRefinementAttributesBuilder

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;

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;

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.

setFollowUpQuestions

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

 Suggested follow-up questions.
 

repeated string follow_up_questions = 2;

Parameters:

index - The index to set the value at.

value - The followUpQuestions to set.

Returns:

This builder for chaining.

addFollowUpQuestions

public SearchResponse.GuidedSearchResult.Builder addFollowUpQuestions(String value)

 Suggested follow-up questions.
 

repeated string follow_up_questions = 2;

Parameters:

value - The followUpQuestions to add.

Returns:

This builder for chaining.

addAllFollowUpQuestions

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

 Suggested follow-up questions.
 

repeated string follow_up_questions = 2;

Parameters:

values - The followUpQuestions to add.

Returns:

This builder for chaining.

clearFollowUpQuestions

public SearchResponse.GuidedSearchResult.Builder clearFollowUpQuestions()

 Suggested follow-up questions.
 

repeated string follow_up_questions = 2;

Returns:

This builder for chaining.

addFollowUpQuestionsBytes

public SearchResponse.GuidedSearchResult.Builder addFollowUpQuestionsBytes(com.google.protobuf.ByteString value)

 Suggested follow-up questions.
 

repeated string follow_up_questions = 2;

Parameters:

value - The bytes of the followUpQuestions to add.

Returns:

This builder for chaining.

setUnknownFields

public final SearchResponse.GuidedSearchResult.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.GuidedSearchResult.Builder>

mergeUnknownFields

public final SearchResponse.GuidedSearchResult.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.GuidedSearchResult.Builder>