Package com.google.cloud.retail.v2alpha

Class SearchRequest.ConversationalSearchSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.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.GeneratedMessage implements SearchRequest.ConversationalSearchSpecOrBuilder
 This field specifies all conversational related parameters addition to
 traditional retail search.
Protobuf type google.cloud.retail.v2alpha.SearchRequest.ConversationalSearchSpec
See Also:

  • Field Details

    • FOLLOWUP_CONVERSATION_REQUESTED_FIELD_NUMBER

      public static final int FOLLOWUP_CONVERSATION_REQUESTED_FIELD_NUMBER
      See Also:

    • CONVERSATION_ID_FIELD_NUMBER

      public static final int CONVERSATION_ID_FIELD_NUMBER
      See Also:

    • USER_ANSWER_FIELD_NUMBER

      public static final int USER_ANSWER_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.v2alpha.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.v2alpha.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.v2alpha.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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public SearchRequest.ConversationalSearchSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder