Package com.google.cloud.discoveryengine.v1

Class StreamAssistResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1.StreamAssistResponse
All Implemented Interfaces:
StreamAssistResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class StreamAssistResponse extends com.google.protobuf.GeneratedMessage implements StreamAssistResponseOrBuilder
 Response for the
 [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist]
 method.
Protobuf type google.cloud.discoveryengine.v1.StreamAssistResponse
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    StreamAssistResponse.Builder
    Response for the [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] method.
    static final class 
    StreamAssistResponse.SessionInfo
    Information about the session.
    static interface 
    StreamAssistResponse.SessionInfoOrBuilder
     

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ANSWER_FIELD_NUMBER
     
    static final int
    ASSIST_TOKEN_FIELD_NUMBER
     
    static final int
    SESSION_INFO_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    equals(Object obj)
     
    AssistAnswer
    getAnswer()
    Assist answer resource object containing parts of the assistant's final answer for the user's query.
    AssistAnswerOrBuilder
    getAnswerOrBuilder()
    Assist answer resource object containing parts of the assistant's final answer for the user's query.
    String
    getAssistToken()
    A global unique ID that identifies the current pair of request and stream of responses.
    com.google.protobuf.ByteString
    getAssistTokenBytes()
    A global unique ID that identifies the current pair of request and stream of responses.
    static StreamAssistResponse
    getDefaultInstance()
     
    StreamAssistResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<StreamAssistResponse>
    getParserForType()
     
    int
    getSerializedSize()
     
    StreamAssistResponse.SessionInfo
    getSessionInfo()
    Session information.
    StreamAssistResponse.SessionInfoOrBuilder
    getSessionInfoOrBuilder()
    Session information.
    boolean
    hasAnswer()
    Assist answer resource object containing parts of the assistant's final answer for the user's query.
    int
    hashCode()
     
    boolean
    hasSessionInfo()
    Session information.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static StreamAssistResponse.Builder
    newBuilder()
     
    static StreamAssistResponse.Builder
    newBuilder(StreamAssistResponse prototype)
     
    StreamAssistResponse.Builder
    newBuilderForType()
     
    protected StreamAssistResponse.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static StreamAssistResponse
    parseDelimitedFrom(InputStream input)
     
    static StreamAssistResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StreamAssistResponse
    parseFrom(byte[] data)
     
    static StreamAssistResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StreamAssistResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static StreamAssistResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StreamAssistResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static StreamAssistResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StreamAssistResponse
    parseFrom(InputStream input)
     
    static StreamAssistResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StreamAssistResponse
    parseFrom(ByteBuffer data)
     
    static StreamAssistResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<StreamAssistResponse>
    parser()
     
    StreamAssistResponse.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • ANSWER_FIELD_NUMBER

      public static final int ANSWER_FIELD_NUMBER
      See Also:

    • SESSION_INFO_FIELD_NUMBER

      public static final int SESSION_INFO_FIELD_NUMBER
      See Also:

    • ASSIST_TOKEN_FIELD_NUMBER

      public static final int ASSIST_TOKEN_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

    • hasAnswer

      public boolean hasAnswer()
       Assist answer resource object containing parts of the assistant's final
 answer for the user's query.

 Not present if the current response doesn't add anything to previously
 sent
 [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies].

 Observe
 [AssistAnswer.state][google.cloud.discoveryengine.v1.AssistAnswer.state] to
 see if more parts are to be expected. While the state is `IN_PROGRESS`, the
 [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies]
 field in each response will contain replies (reply fragments) to be
 appended to the ones received in previous responses. [AssistAnswer.name][]
 won't be filled.

 If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response
 is the last response and [AssistAnswer.name][] will have a value.
      .google.cloud.discoveryengine.v1.AssistAnswer answer = 1;
      Specified by:
      hasAnswer in interface StreamAssistResponseOrBuilder
      Returns:
      Whether the answer field is set.

    • getAnswer

      public AssistAnswer getAnswer()
       Assist answer resource object containing parts of the assistant's final
 answer for the user's query.

 Not present if the current response doesn't add anything to previously
 sent
 [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies].

 Observe
 [AssistAnswer.state][google.cloud.discoveryengine.v1.AssistAnswer.state] to
 see if more parts are to be expected. While the state is `IN_PROGRESS`, the
 [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies]
 field in each response will contain replies (reply fragments) to be
 appended to the ones received in previous responses. [AssistAnswer.name][]
 won't be filled.

 If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response
 is the last response and [AssistAnswer.name][] will have a value.
      .google.cloud.discoveryengine.v1.AssistAnswer answer = 1;
      Specified by:
      getAnswer in interface StreamAssistResponseOrBuilder
      Returns:
      The answer.

    • getAnswerOrBuilder

      public AssistAnswerOrBuilder getAnswerOrBuilder()
       Assist answer resource object containing parts of the assistant's final
 answer for the user's query.

 Not present if the current response doesn't add anything to previously
 sent
 [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies].

 Observe
 [AssistAnswer.state][google.cloud.discoveryengine.v1.AssistAnswer.state] to
 see if more parts are to be expected. While the state is `IN_PROGRESS`, the
 [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies]
 field in each response will contain replies (reply fragments) to be
 appended to the ones received in previous responses. [AssistAnswer.name][]
 won't be filled.

 If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response
 is the last response and [AssistAnswer.name][] will have a value.
      .google.cloud.discoveryengine.v1.AssistAnswer answer = 1;
      Specified by:
      getAnswerOrBuilder in interface StreamAssistResponseOrBuilder

    • hasSessionInfo

      public boolean hasSessionInfo()
       Session information.
      .google.cloud.discoveryengine.v1.StreamAssistResponse.SessionInfo session_info = 2;
      Specified by:
      hasSessionInfo in interface StreamAssistResponseOrBuilder
      Returns:
      Whether the sessionInfo field is set.

    • getSessionInfo

      public StreamAssistResponse.SessionInfo getSessionInfo()
       Session information.
      .google.cloud.discoveryengine.v1.StreamAssistResponse.SessionInfo session_info = 2;
      Specified by:
      getSessionInfo in interface StreamAssistResponseOrBuilder
      Returns:
      The sessionInfo.

    • getSessionInfoOrBuilder

      public StreamAssistResponse.SessionInfoOrBuilder getSessionInfoOrBuilder()
       Session information.
      .google.cloud.discoveryengine.v1.StreamAssistResponse.SessionInfo session_info = 2;
      Specified by:
      getSessionInfoOrBuilder in interface StreamAssistResponseOrBuilder

    • getAssistToken

      public String getAssistToken()
       A global unique ID that identifies the current pair of request and stream
 of responses. Used for feedback and support.
      string assist_token = 4;
      Specified by:
      getAssistToken in interface StreamAssistResponseOrBuilder
      Returns:
      The assistToken.

    • getAssistTokenBytes

      public com.google.protobuf.ByteString getAssistTokenBytes()
       A global unique ID that identifies the current pair of request and stream
 of responses. Used for feedback and support.
      string assist_token = 4;
      Specified by:
      getAssistTokenBytes in interface StreamAssistResponseOrBuilder
      Returns:
      The bytes for assistToken.

    • 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 StreamAssistResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StreamAssistResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StreamAssistResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StreamAssistResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StreamAssistResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StreamAssistResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StreamAssistResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StreamAssistResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StreamAssistResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StreamAssistResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StreamAssistResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StreamAssistResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public StreamAssistResponse.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static StreamAssistResponse.Builder newBuilder()

    • newBuilder

      public static StreamAssistResponse.Builder newBuilder(StreamAssistResponse prototype)

    • toBuilder

      public StreamAssistResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected StreamAssistResponse.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static StreamAssistResponse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<StreamAssistResponse> 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 StreamAssistResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder