Class SearchRequest.ConversationalSearchSpec.Builder (2.57.0)

Version latest

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public static final class SearchRequest.ConversationalSearchSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.ConversationalSearchSpec.Builder> implements SearchRequest.ConversationalSearchSpecOrBuilder

This field specifies all conversational related parameters addition to traditional retail search.

Protobuf type google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchRequest.ConversationalSearchSpec.Builder

Implements

SearchRequest.ConversationalSearchSpecOrBuilder

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.ConversationalSearchSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

Overrides

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

build()

public SearchRequest.ConversationalSearchSpec build()

Returns
Type	Description
SearchRequest.ConversationalSearchSpec

buildPartial()

public SearchRequest.ConversationalSearchSpec buildPartial()

Returns
Type	Description
SearchRequest.ConversationalSearchSpec

clear()

public SearchRequest.ConversationalSearchSpec.Builder clear()

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearConversationId()

public SearchRequest.ConversationalSearchSpec.Builder clearConversationId()

This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous [ConversationalSearchResult.conversation_id][]. For the initial request, this should be empty.

string conversation_id = 2;

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.ConversationalSearchSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

Overrides

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

clearFollowupConversationRequested()

public SearchRequest.ConversationalSearchSpec.Builder clearFollowupConversationRequested()

This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc.

bool followup_conversation_requested = 1;

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.ConversationalSearchSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

Overrides

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

clearUserAnswer()

public SearchRequest.ConversationalSearchSpec.Builder clearUserAnswer()

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3;

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

clone()

public SearchRequest.ConversationalSearchSpec.Builder clone()

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getConversationId()

public String getConversationId()

This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous [ConversationalSearchResult.conversation_id][]. For the initial request, this should be empty.

string conversation_id = 2;

Returns
Type	Description
String	The conversationId.

getConversationIdBytes()

public ByteString getConversationIdBytes()

This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous [ConversationalSearchResult.conversation_id][]. For the initial request, this should be empty.

string conversation_id = 2;

Returns
Type	Description
ByteString	The bytes for conversationId.

getDefaultInstanceForType()

public SearchRequest.ConversationalSearchSpec getDefaultInstanceForType()

Returns
Type	Description
SearchRequest.ConversationalSearchSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFollowupConversationRequested()

public boolean getFollowupConversationRequested()

This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc.

bool followup_conversation_requested = 1;

Returns
Type	Description
boolean	The followupConversationRequested.

getUserAnswer()

public SearchRequest.ConversationalSearchSpec.UserAnswer getUserAnswer()

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3;

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.UserAnswer	The userAnswer.

getUserAnswerBuilder()

public SearchRequest.ConversationalSearchSpec.UserAnswer.Builder getUserAnswerBuilder()

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3;

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.UserAnswer.Builder

getUserAnswerOrBuilder()

public SearchRequest.ConversationalSearchSpec.UserAnswerOrBuilder getUserAnswerOrBuilder()

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3;

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.UserAnswerOrBuilder

hasUserAnswer()

public boolean hasUserAnswer()

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3;

Returns
Type	Description
boolean	Whether the userAnswer field is set.

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(SearchRequest.ConversationalSearchSpec other)

public SearchRequest.ConversationalSearchSpec.Builder mergeFrom(SearchRequest.ConversationalSearchSpec other)

Parameter
Name	Description
other	SearchRequest.ConversationalSearchSpec

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.ConversationalSearchSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchRequest.ConversationalSearchSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.ConversationalSearchSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

Overrides

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

mergeUserAnswer(SearchRequest.ConversationalSearchSpec.UserAnswer value)

public SearchRequest.ConversationalSearchSpec.Builder mergeUserAnswer(SearchRequest.ConversationalSearchSpec.UserAnswer value)

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3;

Parameter
Name	Description
value	SearchRequest.ConversationalSearchSpec.UserAnswer

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

setConversationId(String value)

public SearchRequest.ConversationalSearchSpec.Builder setConversationId(String value)

This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous [ConversationalSearchResult.conversation_id][]. For the initial request, this should be empty.

string conversation_id = 2;

Parameter
Name	Description
value	String The conversationId to set.

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder	This builder for chaining.

setConversationIdBytes(ByteString value)

public SearchRequest.ConversationalSearchSpec.Builder setConversationIdBytes(ByteString value)

This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous [ConversationalSearchResult.conversation_id][]. For the initial request, this should be empty.

string conversation_id = 2;

Parameter
Name	Description
value	ByteString The bytes for conversationId to set.

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.ConversationalSearchSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

Overrides

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

setFollowupConversationRequested(boolean value)

public SearchRequest.ConversationalSearchSpec.Builder setFollowupConversationRequested(boolean value)

This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc.

bool followup_conversation_requested = 1;

Parameter
Name	Description
value	boolean The followupConversationRequested to set.

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder	This builder for chaining.

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

public SearchRequest.ConversationalSearchSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.ConversationalSearchSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

Overrides

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

setUserAnswer(SearchRequest.ConversationalSearchSpec.UserAnswer value)

public SearchRequest.ConversationalSearchSpec.Builder setUserAnswer(SearchRequest.ConversationalSearchSpec.UserAnswer value)

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3;

Parameter
Name	Description
value	SearchRequest.ConversationalSearchSpec.UserAnswer

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder

setUserAnswer(SearchRequest.ConversationalSearchSpec.UserAnswer.Builder builderForValue)

public SearchRequest.ConversationalSearchSpec.Builder setUserAnswer(SearchRequest.ConversationalSearchSpec.UserAnswer.Builder builderForValue)

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3;

Parameter
Name	Description
builderForValue	SearchRequest.ConversationalSearchSpec.UserAnswer.Builder

Returns
Type	Description
SearchRequest.ConversationalSearchSpec.Builder