Class StreamAssistResponse.Builder (0.66.0)

public static final class StreamAssistResponse.Builder extends GeneratedMessageV3.Builder<StreamAssistResponse.Builder> implements StreamAssistResponseOrBuilder

Response for the AssistantService.StreamAssist method.

Protobuf type google.cloud.discoveryengine.v1.StreamAssistResponse

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StreamAssistResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StreamAssistResponse.Builder
Overrides

build()

public StreamAssistResponse build()
Returns
Type Description
StreamAssistResponse

buildPartial()

public StreamAssistResponse buildPartial()
Returns
Type Description
StreamAssistResponse

clear()

public StreamAssistResponse.Builder clear()
Returns
Type Description
StreamAssistResponse.Builder
Overrides

clearAnswer()

public StreamAssistResponse.Builder clearAnswer()

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.v1.AssistAnswer answer = 1;

Returns
Type Description
StreamAssistResponse.Builder

clearAssistToken()

public StreamAssistResponse.Builder clearAssistToken()

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
StreamAssistResponse.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public StreamAssistResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
StreamAssistResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public StreamAssistResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
StreamAssistResponse.Builder
Overrides

clearSessionInfo()

public StreamAssistResponse.Builder clearSessionInfo()

Session information.

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

Returns
Type Description
StreamAssistResponse.Builder

clone()

public StreamAssistResponse.Builder clone()
Returns
Type Description
StreamAssistResponse.Builder
Overrides

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.v1.AssistAnswer answer = 1;

Returns
Type Description
AssistAnswer

The answer.

getAnswerBuilder()

public AssistAnswer.Builder getAnswerBuilder()

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.v1.AssistAnswer answer = 1;

Returns
Type Description
AssistAnswer.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getSessionInfo()

public StreamAssistResponse.SessionInfo getSessionInfo()

Session information.

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

Returns
Type Description
StreamAssistResponse.SessionInfo

The sessionInfo.

getSessionInfoBuilder()

public StreamAssistResponse.SessionInfo.Builder getSessionInfoBuilder()

Session information.

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

Returns
Type Description
StreamAssistResponse.SessionInfo.Builder

getSessionInfoOrBuilder()

public StreamAssistResponse.SessionInfoOrBuilder getSessionInfoOrBuilder()

Session information.

.google.cloud.discoveryengine.v1.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.v1.AssistAnswer answer = 1;

Returns
Type Description
boolean

Whether the answer field is set.

hasSessionInfo()

public boolean hasSessionInfo()

Session information.

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

Returns
Type Description
boolean

Whether the sessionInfo field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAnswer(AssistAnswer value)

public StreamAssistResponse.Builder mergeAnswer(AssistAnswer value)

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.v1.AssistAnswer answer = 1;

Parameter
Name Description
value AssistAnswer
Returns
Type Description
StreamAssistResponse.Builder

mergeFrom(StreamAssistResponse other)

public StreamAssistResponse.Builder mergeFrom(StreamAssistResponse other)
Parameter
Name Description
other StreamAssistResponse
Returns
Type Description
StreamAssistResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StreamAssistResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamAssistResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public StreamAssistResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
StreamAssistResponse.Builder
Overrides

mergeSessionInfo(StreamAssistResponse.SessionInfo value)

public StreamAssistResponse.Builder mergeSessionInfo(StreamAssistResponse.SessionInfo value)

Session information.

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

Parameter
Name Description
value StreamAssistResponse.SessionInfo
Returns
Type Description
StreamAssistResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StreamAssistResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StreamAssistResponse.Builder
Overrides

setAnswer(AssistAnswer value)

public StreamAssistResponse.Builder setAnswer(AssistAnswer value)

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.v1.AssistAnswer answer = 1;

Parameter
Name Description
value AssistAnswer
Returns
Type Description
StreamAssistResponse.Builder

setAnswer(AssistAnswer.Builder builderForValue)

public StreamAssistResponse.Builder setAnswer(AssistAnswer.Builder builderForValue)

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.v1.AssistAnswer answer = 1;

Parameter
Name Description
builderForValue AssistAnswer.Builder
Returns
Type Description
StreamAssistResponse.Builder

setAssistToken(String value)

public StreamAssistResponse.Builder setAssistToken(String value)

A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.

string assist_token = 4;

Parameter
Name Description
value String

The assistToken to set.

Returns
Type Description
StreamAssistResponse.Builder

This builder for chaining.

setAssistTokenBytes(ByteString value)

public StreamAssistResponse.Builder setAssistTokenBytes(ByteString value)

A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.

string assist_token = 4;

Parameter
Name Description
value ByteString

The bytes for assistToken to set.

Returns
Type Description
StreamAssistResponse.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public StreamAssistResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StreamAssistResponse.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StreamAssistResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
StreamAssistResponse.Builder
Overrides

setSessionInfo(StreamAssistResponse.SessionInfo value)

public StreamAssistResponse.Builder setSessionInfo(StreamAssistResponse.SessionInfo value)

Session information.

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

Parameter
Name Description
value StreamAssistResponse.SessionInfo
Returns
Type Description
StreamAssistResponse.Builder

setSessionInfo(StreamAssistResponse.SessionInfo.Builder builderForValue)

public StreamAssistResponse.Builder setSessionInfo(StreamAssistResponse.SessionInfo.Builder builderForValue)

Session information.

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

Parameter
Name Description
builderForValue StreamAssistResponse.SessionInfo.Builder
Returns
Type Description
StreamAssistResponse.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final StreamAssistResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StreamAssistResponse.Builder
Overrides