public final class StreamingReactiveCompanionSuggestionsResponse extends GeneratedMessage implements StreamingReactiveCompanionSuggestionsResponseOrBuilder
The response message for
Participants.StreamingReactiveCompanionSuggestions.
Protobuf type google.cloud.dialogflow.v2.StreamingReactiveCompanionSuggestionsResponse
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
ANSWER_RECORD_FIELD_NUMBER
public static final int ANSWER_RECORD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int INTERMEDIATE_TOOL_CALL_EVENTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
IS_FINAL_FIELD_NUMBER
public static final int IS_FINAL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REACTIVE_MODE_FINAL_RESPONSE_FIELD_NUMBER
public static final int REACTIVE_MODE_FINAL_RESPONSE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESPONSE_CHUNK_FIELD_NUMBER
public static final int RESPONSE_CHUNK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SEND_TIME_FIELD_NUMBER
public static final int SEND_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TEXT_MESSAGE_ID_FIELD_NUMBER
public static final int TEXT_MESSAGE_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static StreamingReactiveCompanionSuggestionsResponse getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static StreamingReactiveCompanionSuggestionsResponse.Builder newBuilder()
newBuilder(StreamingReactiveCompanionSuggestionsResponse prototype)
public static StreamingReactiveCompanionSuggestionsResponse.Builder newBuilder(StreamingReactiveCompanionSuggestionsResponse prototype)
public static StreamingReactiveCompanionSuggestionsResponse parseDelimitedFrom(InputStream input)
public static StreamingReactiveCompanionSuggestionsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static StreamingReactiveCompanionSuggestionsResponse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StreamingReactiveCompanionSuggestionsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static StreamingReactiveCompanionSuggestionsResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StreamingReactiveCompanionSuggestionsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StreamingReactiveCompanionSuggestionsResponse parseFrom(CodedInputStream input)
public static StreamingReactiveCompanionSuggestionsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StreamingReactiveCompanionSuggestionsResponse parseFrom(InputStream input)
public static StreamingReactiveCompanionSuggestionsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static StreamingReactiveCompanionSuggestionsResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StreamingReactiveCompanionSuggestionsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<StreamingReactiveCompanionSuggestionsResponse> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAnswerRecord()
public String getAnswerRecord()
Output only. Only set when is_final is true and conversational turn
processing completes. The final answer record representing the completed
suggestion. Only present in the last chunk of the completed response.
string answer_record = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The answerRecord.
|
getAnswerRecordBytes()
public ByteString getAnswerRecordBytes()
Output only. Only set when is_final is true and conversational turn
processing completes. The final answer record representing the completed
suggestion. Only present in the last chunk of the completed response.
string answer_record = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for answerRecord.
|
getDefaultInstanceForType()
public StreamingReactiveCompanionSuggestionsResponse getDefaultInstanceForType()
public ToolCallEvents getIntermediateToolCallEvents()
Output only. Captures intermediate tool call events that occur during the
execution of the reactive query turn. Note that conversational messages
within tool calls are displayed within the tool cards and hence are not
accumulated within the reactive_mode_final_response.response string.
.google.cloud.dialogflow.v2.ToolCallEvents intermediate_tool_call_events = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ToolCallEvents |
The intermediateToolCallEvents.
|
public ToolCallEventsOrBuilder getIntermediateToolCallEventsOrBuilder()
Output only. Captures intermediate tool call events that occur during the
execution of the reactive query turn. Note that conversational messages
within tool calls are displayed within the tool cards and hence are not
accumulated within the reactive_mode_final_response.response string.
.google.cloud.dialogflow.v2.ToolCallEvents intermediate_tool_call_events = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getIsFinal()
public boolean getIsFinal()
Output only. Indicates whether the client/UI can accept a new query for
reactive chat. When is_final is true, the reactive chat interface is
unblocked and ready to receive new human agent queries. For synchronous
turns, this is set to true on the final response chunk. For asynchronous
tool calls running in the background, this is set to true on the
intermediate trigger chunk to unblock the UI while the background tool
execution is in progress.
bool is_final = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
The isFinal.
|
getParserForType()
public Parser<StreamingReactiveCompanionSuggestionsResponse> getParserForType()
Overrides
getReactiveModeFinalResponse()
public StreamingReactiveCompanionSuggestionsResponse.ReactiveModeResponse getReactiveModeFinalResponse()
Output only. The final response from the reactive mode capturing the
entire accumulated streaming response, grounding metadata, and tool
calls. Only set when is_final is true and conversational processing
for the query turn completes.
.google.cloud.dialogflow.v2.StreamingReactiveCompanionSuggestionsResponse.ReactiveModeResponse reactive_mode_final_response = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getReactiveModeFinalResponseOrBuilder()
public StreamingReactiveCompanionSuggestionsResponse.ReactiveModeResponseOrBuilder getReactiveModeFinalResponseOrBuilder()
Output only. The final response from the reactive mode capturing the
entire accumulated streaming response, grounding metadata, and tool
calls. Only set when is_final is true and conversational processing
for the query turn completes.
.google.cloud.dialogflow.v2.StreamingReactiveCompanionSuggestionsResponse.ReactiveModeResponse reactive_mode_final_response = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getResponseCase()
public StreamingReactiveCompanionSuggestionsResponse.ResponseCase getResponseCase()
getResponseChunk()
public String getResponseChunk()
Streamed response text chunks.
string response_chunk = 1;
| Returns |
| Type |
Description |
String |
The responseChunk.
|
getResponseChunkBytes()
public ByteString getResponseChunkBytes()
Streamed response text chunks.
string response_chunk = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for responseChunk.
|
getSendTime()
public Timestamp getSendTime()
The timestamp when the response chunk was sent by the service.
.google.protobuf.Timestamp send_time = 9;
| Returns |
| Type |
Description |
Timestamp |
The sendTime.
|
getSendTimeOrBuilder()
public TimestampOrBuilder getSendTimeOrBuilder()
The timestamp when the response chunk was sent by the service.
.google.protobuf.Timestamp send_time = 9;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getStatus()
public Status getStatus()
Status of the response for the current query. If set and non-ok,
indicates an error occurred during processing of the current query, or
confirms that a requested cancellation has successfully completed (status
code CANCELLED).
.google.rpc.Status status = 3;
| Returns |
| Type |
Description |
com.google.rpc.Status |
The status.
|
getStatusOrBuilder()
public StatusOrBuilder getStatusOrBuilder()
Status of the response for the current query. If set and non-ok,
indicates an error occurred during processing of the current query, or
confirms that a requested cancellation has successfully completed (status
code CANCELLED).
.google.rpc.Status status = 3;
| Returns |
| Type |
Description |
com.google.rpc.StatusOrBuilder |
|
getTextMessageId()
public String getTextMessageId()
Required. The unique message identifier corresponding to the
human agent query that generated this response chunk.
string text_message_id = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The textMessageId.
|
getTextMessageIdBytes()
public ByteString getTextMessageIdBytes()
Required. The unique message identifier corresponding to the
human agent query that generated this response chunk.
string text_message_id = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for textMessageId.
|
public boolean hasIntermediateToolCallEvents()
Output only. Captures intermediate tool call events that occur during the
execution of the reactive query turn. Note that conversational messages
within tool calls are displayed within the tool cards and hence are not
accumulated within the reactive_mode_final_response.response string.
.google.cloud.dialogflow.v2.ToolCallEvents intermediate_tool_call_events = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the intermediateToolCallEvents field is set.
|
hasReactiveModeFinalResponse()
public boolean hasReactiveModeFinalResponse()
Output only. The final response from the reactive mode capturing the
entire accumulated streaming response, grounding metadata, and tool
calls. Only set when is_final is true and conversational processing
for the query turn completes.
.google.cloud.dialogflow.v2.StreamingReactiveCompanionSuggestionsResponse.ReactiveModeResponse reactive_mode_final_response = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the reactiveModeFinalResponse field is set.
|
hasResponseChunk()
public boolean hasResponseChunk()
Streamed response text chunks.
string response_chunk = 1;
| Returns |
| Type |
Description |
boolean |
Whether the responseChunk field is set.
|
hasSendTime()
public boolean hasSendTime()
The timestamp when the response chunk was sent by the service.
.google.protobuf.Timestamp send_time = 9;
| Returns |
| Type |
Description |
boolean |
Whether the sendTime field is set.
|
hasStatus()
public boolean hasStatus()
Status of the response for the current query. If set and non-ok,
indicates an error occurred during processing of the current query, or
confirms that a requested cancellation has successfully completed (status
code CANCELLED).
.google.rpc.Status status = 3;
| Returns |
| Type |
Description |
boolean |
Whether the status field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public StreamingReactiveCompanionSuggestionsResponse.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected StreamingReactiveCompanionSuggestionsResponse.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public StreamingReactiveCompanionSuggestionsResponse.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides