Class StreamAssistResponse (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public final class StreamAssistResponse extends GeneratedMessage implements StreamAssistResponseOrBuilder

Response for the AssistantService.StreamAssist method.

Protobuf type google.cloud.discoveryengine.v1beta.StreamAssistResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > StreamAssistResponse

Implements

StreamAssistResponseOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

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()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

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()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ANSWER_FIELD_NUMBER

public static final int ANSWER_FIELD_NUMBER

Field Value
Type	Description
int

ASSIST_TOKEN_FIELD_NUMBER

public static final int ASSIST_TOKEN_FIELD_NUMBER

Field Value
Type	Description
int

INVOCATION_TOOLS_FIELD_NUMBER

public static final int INVOCATION_TOOLS_FIELD_NUMBER

Field Value
Type	Description
int

INVOKED_SKILLS_FIELD_NUMBER

public static final int INVOKED_SKILLS_FIELD_NUMBER

Field Value
Type	Description
int

SESSION_INFO_FIELD_NUMBER

public static final int SESSION_INFO_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static StreamAssistResponse getDefaultInstance()

Returns
Type	Description
StreamAssistResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static StreamAssistResponse.Builder newBuilder()

Returns
Type	Description
StreamAssistResponse.Builder

newBuilder(StreamAssistResponse prototype)

public static StreamAssistResponse.Builder newBuilder(StreamAssistResponse prototype)

Parameter
Name	Description
prototype	StreamAssistResponse

Returns
Type	Description
StreamAssistResponse.Builder

parseDelimitedFrom(InputStream input)

public static StreamAssistResponse parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
StreamAssistResponse

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamAssistResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StreamAssistResponse

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static StreamAssistResponse parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
StreamAssistResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StreamAssistResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StreamAssistResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StreamAssistResponse parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
StreamAssistResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StreamAssistResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StreamAssistResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StreamAssistResponse parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
StreamAssistResponse

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamAssistResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StreamAssistResponse

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static StreamAssistResponse parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
StreamAssistResponse

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamAssistResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StreamAssistResponse

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static StreamAssistResponse parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
StreamAssistResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StreamAssistResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StreamAssistResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<StreamAssistResponse> parser()

Returns
Type	Description
Parser<StreamAssistResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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.

Observe AssistAnswer.state to see if more parts are to be expected. While the state is IN_PROGRESS, the 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.v1beta.AssistAnswer answer = 1;

Returns
Type	Description
AssistAnswer	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.

Observe AssistAnswer.state to see if more parts are to be expected. While the state is IN_PROGRESS, the 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.v1beta.AssistAnswer answer = 1;

Returns
Type	Description
AssistAnswerOrBuilder

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;

Returns
Type	Description
String	The assistToken.

getAssistTokenBytes()

public 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;

Returns
Type	Description
ByteString	The bytes for assistToken.

getDefaultInstanceForType()

public StreamAssistResponse getDefaultInstanceForType()

Returns
Type	Description
StreamAssistResponse

getInvocationTools(int index)

public String getInvocationTools(int index)

The tool names of the tools that were invoked.

repeated string invocation_tools = 8;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The invocationTools at the given index.

getInvocationToolsBytes(int index)

public ByteString getInvocationToolsBytes(int index)

The tool names of the tools that were invoked.

repeated string invocation_tools = 8;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the invocationTools at the given index.

getInvocationToolsCount()

public int getInvocationToolsCount()

The tool names of the tools that were invoked.

repeated string invocation_tools = 8;

Returns
Type	Description
int	The count of invocationTools.

getInvocationToolsList()

public ProtocolStringList getInvocationToolsList()

The tool names of the tools that were invoked.

repeated string invocation_tools = 8;

Returns
Type	Description
ProtocolStringList	A list containing the invocationTools.

getInvokedSkills(int index)

public StreamAssistResponse.InvokedSkill getInvokedSkills(int index)

The skills executed during the turn.

repeated .google.cloud.discoveryengine.v1beta.StreamAssistResponse.InvokedSkill invoked_skills = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
StreamAssistResponse.InvokedSkill

getInvokedSkillsCount()

public int getInvokedSkillsCount()

The skills executed during the turn.

repeated .google.cloud.discoveryengine.v1beta.StreamAssistResponse.InvokedSkill invoked_skills = 10;

Returns
Type	Description
int

getInvokedSkillsList()

public List<StreamAssistResponse.InvokedSkill> getInvokedSkillsList()

The skills executed during the turn.

repeated .google.cloud.discoveryengine.v1beta.StreamAssistResponse.InvokedSkill invoked_skills = 10;

Returns
Type	Description
List<InvokedSkill>

getInvokedSkillsOrBuilder(int index)

public StreamAssistResponse.InvokedSkillOrBuilder getInvokedSkillsOrBuilder(int index)

The skills executed during the turn.

repeated .google.cloud.discoveryengine.v1beta.StreamAssistResponse.InvokedSkill invoked_skills = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
StreamAssistResponse.InvokedSkillOrBuilder

getInvokedSkillsOrBuilderList()

public List<? extends StreamAssistResponse.InvokedSkillOrBuilder> getInvokedSkillsOrBuilderList()

The skills executed during the turn.

repeated .google.cloud.discoveryengine.v1beta.StreamAssistResponse.InvokedSkill invoked_skills = 10;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1beta.StreamAssistResponse.InvokedSkillOrBuilder>

getParserForType()

public Parser<StreamAssistResponse> getParserForType()

Returns
Type	Description
Parser<StreamAssistResponse>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getSessionInfo()

public StreamAssistResponse.SessionInfo getSessionInfo()

Session information. Only included in the final StreamAssistResponse of the response stream.

.google.cloud.discoveryengine.v1beta.StreamAssistResponse.SessionInfo session_info = 2;

Returns
Type	Description
StreamAssistResponse.SessionInfo	The sessionInfo.

getSessionInfoOrBuilder()

public StreamAssistResponse.SessionInfoOrBuilder getSessionInfoOrBuilder()

Session information. Only included in the final StreamAssistResponse of the response stream.

.google.cloud.discoveryengine.v1beta.StreamAssistResponse.SessionInfo session_info = 2;

Returns
Type	Description
StreamAssistResponse.SessionInfoOrBuilder

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.

Observe AssistAnswer.state to see if more parts are to be expected. While the state is IN_PROGRESS, the 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.v1beta.AssistAnswer answer = 1;

Returns
Type	Description
boolean	Whether the answer field is set.

hasSessionInfo()

public boolean hasSessionInfo()

Session information. Only included in the final StreamAssistResponse of the response stream.

.google.cloud.discoveryengine.v1beta.StreamAssistResponse.SessionInfo session_info = 2;

Returns
Type	Description
boolean	Whether the sessionInfo field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public StreamAssistResponse.Builder newBuilderForType()

Returns
Type	Description
StreamAssistResponse.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected StreamAssistResponse.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
StreamAssistResponse.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public StreamAssistResponse.Builder toBuilder()

Returns
Type	Description
StreamAssistResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException