Class SearchResponse.ConversationalSearchResult (2.54.0)

public static final class SearchResponse.ConversationalSearchResult extends GeneratedMessageV3 implements SearchResponse.ConversationalSearchResultOrBuilder

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

Protobuf type google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult

Inheritance

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

Implements

SearchResponse.ConversationalSearchResultOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ADDITIONAL_FILTERS_FIELD_NUMBER

public static final int ADDITIONAL_FILTERS_FIELD_NUMBER

Field Value
Type	Description
`int`

ADDITIONAL_FILTER_FIELD_NUMBER

public static final int ADDITIONAL_FILTER_FIELD_NUMBER

Field Value
Type	Description
`int`

CONVERSATION_ID_FIELD_NUMBER

public static final int CONVERSATION_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

FOLLOWUP_QUESTION_FIELD_NUMBER

public static final int FOLLOWUP_QUESTION_FIELD_NUMBER

Field Value
Type	Description
`int`

REFINED_QUERY_FIELD_NUMBER

public static final int REFINED_QUERY_FIELD_NUMBER

Field Value
Type	Description
`int`

SUGGESTED_ANSWERS_FIELD_NUMBER

public static final int SUGGESTED_ANSWERS_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static SearchResponse.ConversationalSearchResult getDefaultInstance()

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static SearchResponse.ConversationalSearchResult.Builder newBuilder()

Returns
Type	Description
`SearchResponse.ConversationalSearchResult.Builder`

newBuilder(SearchResponse.ConversationalSearchResult prototype)

public static SearchResponse.ConversationalSearchResult.Builder newBuilder(SearchResponse.ConversationalSearchResult prototype)

Parameter
Name	Description
`prototype`	`SearchResponse.ConversationalSearchResult`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult.Builder`

parseDelimitedFrom(InputStream input)

public static SearchResponse.ConversationalSearchResult parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.ConversationalSearchResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static SearchResponse.ConversationalSearchResult parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.ConversationalSearchResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static SearchResponse.ConversationalSearchResult parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.ConversationalSearchResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static SearchResponse.ConversationalSearchResult parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.ConversationalSearchResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static SearchResponse.ConversationalSearchResult parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.ConversationalSearchResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static SearchResponse.ConversationalSearchResult parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.ConversationalSearchResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<SearchResponse.ConversationalSearchResult> parser()

Returns
Type	Description
`Parser<ConversationalSearchResult>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getAdditionalFilter()

public SearchResponse.ConversationalSearchResult.AdditionalFilter getAdditionalFilter()

This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous SearchRequest.filter, and use the merged filter in the follow up search request.

.google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;

Returns
Type	Description
`SearchResponse.ConversationalSearchResult.AdditionalFilter`	The additionalFilter.

getAdditionalFilterOrBuilder()

public SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder getAdditionalFilterOrBuilder()

.google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;

Returns
Type	Description
`SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder`

getAdditionalFilters(int index) (deprecated)

public SearchResponse.ConversationalSearchResult.AdditionalFilter getAdditionalFilters(int index)

This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field additional_filter.

repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult.AdditionalFilter`

getAdditionalFiltersCount() (deprecated)

public int getAdditionalFiltersCount()

This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field additional_filter.

repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];

Returns
Type	Description
`int`

getAdditionalFiltersList() (deprecated)

public List<SearchResponse.ConversationalSearchResult.AdditionalFilter> getAdditionalFiltersList()

This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field additional_filter.

repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];

Returns
Type	Description
`List<AdditionalFilter>`

getAdditionalFiltersOrBuilder(int index) (deprecated)

public SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder getAdditionalFiltersOrBuilder(int index)

This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field additional_filter.

repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder`

getAdditionalFiltersOrBuilderList() (deprecated)

public List<? extends SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder> getAdditionalFiltersOrBuilderList()

This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field additional_filter.

repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];

Returns
Type	Description
`List<? extends com.google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder>`

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 SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server.

string conversation_id = 1;

Returns
Type	Description
`String`	The conversationId.

getConversationIdBytes()

public ByteString getConversationIdBytes()

string conversation_id = 1;

Returns
Type	Description
`ByteString`	The bytes for conversationId.

getDefaultInstanceForType()

public SearchResponse.ConversationalSearchResult getDefaultInstanceForType()

Returns
Type	Description
`SearchResponse.ConversationalSearchResult`

getFollowupQuestion()

public String getFollowupQuestion()

The follow-up question. e.g., What is the color?

string followup_question = 4;

Returns
Type	Description
`String`	The followupQuestion.

getFollowupQuestionBytes()

public ByteString getFollowupQuestionBytes()

The follow-up question. e.g., What is the color?

string followup_question = 4;

Returns
Type	Description
`ByteString`	The bytes for followupQuestion.

getParserForType()

public Parser<SearchResponse.ConversationalSearchResult> getParserForType()

Returns
Type	Description
`Parser<ConversationalSearchResult>`

Overrides

GeneratedMessageV3.getParserForType()

getRefinedQuery()

public String getRefinedQuery()

The current refined query for the conversational search. This field will be used in customer UI that the query in the search bar should be replaced with the refined query. For example, if SearchRequest.query is dress and next SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is red color, which does not match any product attribute value filters, the refined query will be dress, red color.

string refined_query = 2;

Returns
Type	Description
`String`	The refinedQuery.

getRefinedQueryBytes()

public ByteString getRefinedQueryBytes()

string refined_query = 2;

Returns
Type	Description
`ByteString`	The bytes for refinedQuery.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()