com.google.cloud.retail.v2

Class SearchRequest.ConversationalSearchSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec

All Implemented Interfaces:

SearchRequest.ConversationalSearchSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchRequest

public static final class SearchRequest.ConversationalSearchSpec
extends com.google.protobuf.GeneratedMessageV3
implements SearchRequest.ConversationalSearchSpecOrBuilder

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchRequest.ConversationalSearchSpec.Builder This field specifies all conversational related parameters addition to traditional retail search.
static class	SearchRequest.ConversationalSearchSpec.UserAnswer This field specifies the current user answer during the conversational search.
static interface	SearchRequest.ConversationalSearchSpec.UserAnswerOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONVERSATION_ID_FIELD_NUMBER
static int	FOLLOWUP_CONVERSATION_REQUESTED_FIELD_NUMBER
static int	USER_ANSWER_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getConversationId() This field specifies the conversation id, which maintains the state of the conversation between client side and server side.
com.google.protobuf.ByteString	getConversationIdBytes() This field specifies the conversation id, which maintains the state of the conversation between client side and server side.
static SearchRequest.ConversationalSearchSpec	getDefaultInstance()
SearchRequest.ConversationalSearchSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getFollowupConversationRequested() This field specifies whether the customer would like to do conversational search.
com.google.protobuf.Parser<SearchRequest.ConversationalSearchSpec>	getParserForType()
int	getSerializedSize()
SearchRequest.ConversationalSearchSpec.UserAnswer	getUserAnswer() This field specifies the current user answer during the conversational search.
SearchRequest.ConversationalSearchSpec.UserAnswerOrBuilder	getUserAnswerOrBuilder() This field specifies the current user answer during the conversational search.
int	hashCode()
boolean	hasUserAnswer() This field specifies the current user answer during the conversational search.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchRequest.ConversationalSearchSpec.Builder	newBuilder()
static SearchRequest.ConversationalSearchSpec.Builder	newBuilder(SearchRequest.ConversationalSearchSpec prototype)
SearchRequest.ConversationalSearchSpec.Builder	newBuilderForType()
protected SearchRequest.ConversationalSearchSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchRequest.ConversationalSearchSpec	parseDelimitedFrom(InputStream input)
static SearchRequest.ConversationalSearchSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ConversationalSearchSpec	parseFrom(byte[] data)
static SearchRequest.ConversationalSearchSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ConversationalSearchSpec	parseFrom(ByteBuffer data)
static SearchRequest.ConversationalSearchSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ConversationalSearchSpec	parseFrom(com.google.protobuf.ByteString data)
static SearchRequest.ConversationalSearchSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ConversationalSearchSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchRequest.ConversationalSearchSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ConversationalSearchSpec	parseFrom(InputStream input)
static SearchRequest.ConversationalSearchSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchRequest.ConversationalSearchSpec>	parser()
SearchRequest.ConversationalSearchSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FOLLOWUP_CONVERSATION_REQUESTED_FIELD_NUMBER

public static final int FOLLOWUP_CONVERSATION_REQUESTED_FIELD_NUMBER

See Also:

Constant Field Values

CONVERSATION_ID_FIELD_NUMBER

public static final int CONVERSATION_ID_FIELD_NUMBER

See Also:

Constant Field Values

USER_ANSWER_FIELD_NUMBER

public static final int USER_ANSWER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

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;

Specified by:

getFollowupConversationRequested in interface SearchRequest.ConversationalSearchSpecOrBuilder

Returns:

The followupConversationRequested.

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;

Specified by:

getConversationId in interface SearchRequest.ConversationalSearchSpecOrBuilder

Returns:

The conversationId.

getConversationIdBytes

public com.google.protobuf.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;

Specified by:

getConversationIdBytes in interface SearchRequest.ConversationalSearchSpecOrBuilder

Returns:

The bytes for conversationId.

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;

Specified by:

hasUserAnswer in interface SearchRequest.ConversationalSearchSpecOrBuilder

Returns:

Whether the userAnswer field is set.

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;

Specified by:

getUserAnswer in interface SearchRequest.ConversationalSearchSpecOrBuilder

Returns:

The userAnswer.

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;

Specified by:

getUserAnswerOrBuilder in interface SearchRequest.ConversationalSearchSpecOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchRequest.ConversationalSearchSpec parseFrom(ByteBuffer data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ConversationalSearchSpec parseFrom(ByteBuffer data,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ConversationalSearchSpec parseFrom(com.google.protobuf.ByteString data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ConversationalSearchSpec parseFrom(com.google.protobuf.ByteString data,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ConversationalSearchSpec parseFrom(byte[] data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ConversationalSearchSpec parseFrom(byte[] data,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ConversationalSearchSpec parseFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.ConversationalSearchSpec parseFrom(InputStream input,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.ConversationalSearchSpec parseDelimitedFrom(InputStream input)
                                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.ConversationalSearchSpec parseDelimitedFrom(InputStream input,
                                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                 throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.ConversationalSearchSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                                        throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.ConversationalSearchSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

newBuilderForType

public SearchRequest.ConversationalSearchSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchRequest.ConversationalSearchSpec.Builder newBuilder()

newBuilder

public static SearchRequest.ConversationalSearchSpec.Builder newBuilder(SearchRequest.ConversationalSearchSpec prototype)

toBuilder

public SearchRequest.ConversationalSearchSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchRequest.ConversationalSearchSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchRequest.ConversationalSearchSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchRequest.ConversationalSearchSpec> parser()

getParserForType

public com.google.protobuf.Parser<SearchRequest.ConversationalSearchSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SearchRequest.ConversationalSearchSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder