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

Inheritance

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

Implements

SearchResponse.GuidedSearchResultOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SearchResponse.GuidedSearchResult.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`SearchResponse.GuidedSearchResult.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchResponse.GuidedSearchResult getDefaultInstanceForType()

Returns
Type	Description
`SearchResponse.GuidedSearchResult`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.GuidedSearchResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchResponse.GuidedSearchResult.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.GuidedSearchResult.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchResponse.GuidedSearchResult.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)