Class ConversationalSearchResponse.Builder (2.64.0) 

public static final class ConversationalSearchResponse.Builder extends GeneratedMessageV3.Builder<ConversationalSearchResponse.Builder> implements ConversationalSearchResponseOrBuilder

Response message for ConversationalSearchService.ConversationalSearch method.

Protobuf type google.cloud.retail.v2alpha.ConversationalSearchResponse

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ConversationalSearchResponse.Builder

Static Methods

getDescriptor()

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

Methods

addAllRefinedSearch(Iterable<? extends ConversationalSearchResponse.RefinedSearch> values)

public ConversationalSearchResponse.Builder addAllRefinedSearch(Iterable<? extends ConversationalSearchResponse.RefinedSearch> values)

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Parameter
Name Description
values Iterable<? extends com.google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch>
Returns
Type Description
ConversationalSearchResponse.Builder

addRefinedSearch(ConversationalSearchResponse.RefinedSearch value)

public ConversationalSearchResponse.Builder addRefinedSearch(ConversationalSearchResponse.RefinedSearch value)

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Parameter
Name Description
value ConversationalSearchResponse.RefinedSearch
Returns
Type Description
ConversationalSearchResponse.Builder

addRefinedSearch(ConversationalSearchResponse.RefinedSearch.Builder builderForValue)

public ConversationalSearchResponse.Builder addRefinedSearch(ConversationalSearchResponse.RefinedSearch.Builder builderForValue)

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Parameter
Name Description
builderForValue ConversationalSearchResponse.RefinedSearch.Builder
Returns
Type Description
ConversationalSearchResponse.Builder

addRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch value)

public ConversationalSearchResponse.Builder addRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch value)

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Parameters
Name Description
index int
value ConversationalSearchResponse.RefinedSearch
Returns
Type Description
ConversationalSearchResponse.Builder

addRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch.Builder builderForValue)

public ConversationalSearchResponse.Builder addRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch.Builder builderForValue)

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Parameters
Name Description
index int
builderForValue ConversationalSearchResponse.RefinedSearch.Builder
Returns
Type Description
ConversationalSearchResponse.Builder

addRefinedSearchBuilder()

public ConversationalSearchResponse.RefinedSearch.Builder addRefinedSearchBuilder()

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Returns
Type Description
ConversationalSearchResponse.RefinedSearch.Builder

addRefinedSearchBuilder(int index)

public ConversationalSearchResponse.RefinedSearch.Builder addRefinedSearchBuilder(int index)

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Parameter
Name Description
index int
Returns
Type Description
ConversationalSearchResponse.RefinedSearch.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ConversationalSearchResponse build()
Returns
Type Description
ConversationalSearchResponse

buildPartial()

public ConversationalSearchResponse buildPartial()
Returns
Type Description
ConversationalSearchResponse

clear()

public ConversationalSearchResponse.Builder clear()
Returns
Type Description
ConversationalSearchResponse.Builder
Overrides

clearConversationId()

public ConversationalSearchResponse.Builder clearConversationId()

Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.

string conversation_id = 4;

Returns
Type Description
ConversationalSearchResponse.Builder

This builder for chaining.

clearConversationalFilteringResult()

public ConversationalSearchResponse.Builder clearConversationalFilteringResult()

This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.

.google.cloud.retail.v2alpha.ConversationalSearchResponse.ConversationalFilteringResult conversational_filtering_result = 7;

Returns
Type Description
ConversationalSearchResponse.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRefinedSearch()

public ConversationalSearchResponse.Builder clearRefinedSearch()

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Returns
Type Description
ConversationalSearchResponse.Builder

clone()

public ConversationalSearchResponse.Builder clone()
Returns
Type Description
ConversationalSearchResponse.Builder
Overrides

getConversationId()

public String getConversationId()

Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.

string conversation_id = 4;

Returns
Type Description
String

The conversationId.

getConversationIdBytes()

public ByteString getConversationIdBytes()

Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.

string conversation_id = 4;

Returns
Type Description
ByteString

The bytes for conversationId.

getConversationalFilteringResult()

public ConversationalSearchResponse.ConversationalFilteringResult getConversationalFilteringResult()

This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.

.google.cloud.retail.v2alpha.ConversationalSearchResponse.ConversationalFilteringResult conversational_filtering_result = 7;

Returns
Type Description
ConversationalSearchResponse.ConversationalFilteringResult

The conversationalFilteringResult.

getConversationalFilteringResultBuilder()

public ConversationalSearchResponse.ConversationalFilteringResult.Builder getConversationalFilteringResultBuilder()

This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.

.google.cloud.retail.v2alpha.ConversationalSearchResponse.ConversationalFilteringResult conversational_filtering_result = 7;

Returns
Type Description
ConversationalSearchResponse.ConversationalFilteringResult.Builder

getConversationalFilteringResultOrBuilder()

public ConversationalSearchResponse.ConversationalFilteringResultOrBuilder getConversationalFilteringResultOrBuilder()

This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.

.google.cloud.retail.v2alpha.ConversationalSearchResponse.ConversationalFilteringResult conversational_filtering_result = 7;

Returns
Type Description
ConversationalSearchResponse.ConversationalFilteringResultOrBuilder

getDefaultInstanceForType()

public ConversationalSearchResponse getDefaultInstanceForType()
Returns
Type Description
ConversationalSearchResponse

getDescriptorForType()

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

getRefinedSearch(int index)

public ConversationalSearchResponse.RefinedSearch getRefinedSearch(int index)

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Parameter
Name Description
index int
Returns
Type Description
ConversationalSearchResponse.RefinedSearch

getRefinedSearchBuilder(int index)

public ConversationalSearchResponse.RefinedSearch.Builder getRefinedSearchBuilder(int index)

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Parameter
Name Description
index int
Returns
Type Description
ConversationalSearchResponse.RefinedSearch.Builder

getRefinedSearchBuilderList()

public List<ConversationalSearchResponse.RefinedSearch.Builder> getRefinedSearchBuilderList()

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Returns
Type Description
List<Builder>

getRefinedSearchCount()

public int getRefinedSearchCount()

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Returns
Type Description
int

getRefinedSearchList()

public List<ConversationalSearchResponse.RefinedSearch> getRefinedSearchList()

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Returns
Type Description
List<RefinedSearch>

getRefinedSearchOrBuilder(int index)

public ConversationalSearchResponse.RefinedSearchOrBuilder getRefinedSearchOrBuilder(int index)

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Parameter
Name Description
index int
Returns
Type Description
ConversationalSearchResponse.RefinedSearchOrBuilder

getRefinedSearchOrBuilderList()

public List<? extends ConversationalSearchResponse.RefinedSearchOrBuilder> getRefinedSearchOrBuilderList()

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Returns
Type Description
List<? extends com.google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearchOrBuilder>

hasConversationalFilteringResult()

public boolean hasConversationalFilteringResult()

This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.

.google.cloud.retail.v2alpha.ConversationalSearchResponse.ConversationalFilteringResult conversational_filtering_result = 7;

Returns
Type Description
boolean

Whether the conversationalFilteringResult field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeConversationalFilteringResult(ConversationalSearchResponse.ConversationalFilteringResult value)

public ConversationalSearchResponse.Builder mergeConversationalFilteringResult(ConversationalSearchResponse.ConversationalFilteringResult value)

This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.

.google.cloud.retail.v2alpha.ConversationalSearchResponse.ConversationalFilteringResult conversational_filtering_result = 7;

Parameter
Name Description
value ConversationalSearchResponse.ConversationalFilteringResult
Returns
Type Description
ConversationalSearchResponse.Builder

mergeFrom(ConversationalSearchResponse other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeRefinedSearch(int index)

public ConversationalSearchResponse.Builder removeRefinedSearch(int index)

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Parameter
Name Description
index int
Returns
Type Description
ConversationalSearchResponse.Builder

setConversationId(String value)

public ConversationalSearchResponse.Builder setConversationId(String value)

Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.

string conversation_id = 4;

Parameter
Name Description
value String

The conversationId to set.
Returns
Type Description
ConversationalSearchResponse.Builder

This builder for chaining.

setConversationIdBytes(ByteString value)

public ConversationalSearchResponse.Builder setConversationIdBytes(ByteString value)

Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.

string conversation_id = 4;

Parameter
Name Description
value ByteString

The bytes for conversationId to set.
Returns
Type Description
ConversationalSearchResponse.Builder

This builder for chaining.

setConversationalFilteringResult(ConversationalSearchResponse.ConversationalFilteringResult value)

public ConversationalSearchResponse.Builder setConversationalFilteringResult(ConversationalSearchResponse.ConversationalFilteringResult value)

This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.

.google.cloud.retail.v2alpha.ConversationalSearchResponse.ConversationalFilteringResult conversational_filtering_result = 7;

Parameter
Name Description
value ConversationalSearchResponse.ConversationalFilteringResult
Returns
Type Description
ConversationalSearchResponse.Builder

setConversationalFilteringResult(ConversationalSearchResponse.ConversationalFilteringResult.Builder builderForValue)

public ConversationalSearchResponse.Builder setConversationalFilteringResult(ConversationalSearchResponse.ConversationalFilteringResult.Builder builderForValue)

This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.

.google.cloud.retail.v2alpha.ConversationalSearchResponse.ConversationalFilteringResult conversational_filtering_result = 7;

Parameter
Name Description
builderForValue ConversationalSearchResponse.ConversationalFilteringResult.Builder
Returns
Type Description
ConversationalSearchResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch value)

public ConversationalSearchResponse.Builder setRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch value)

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Parameters
Name Description
index int
value ConversationalSearchResponse.RefinedSearch
Returns
Type Description
ConversationalSearchResponse.Builder

setRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch.Builder builderForValue)

public ConversationalSearchResponse.Builder setRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch.Builder builderForValue)

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Parameters
Name Description
index int
builderForValue ConversationalSearchResponse.RefinedSearch.Builder
Returns
Type Description
ConversationalSearchResponse.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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