Class AssistantConfirmationRequest (0.19.0)

public final class AssistantConfirmationRequest extends GeneratedMessage implements AssistantConfirmationRequestOrBuilder

A blocking question or confirmation the assistant needs answered before an agent action can proceed. The requesting agent is paused and resumes only when the answer arrives on a later StreamChatAiAssistantRequest.confirmation_response.

Protobuf type google.cloud.ces.v1beta.AssistantConfirmationRequest

Inheritance

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

Static Fields

AGENT_NAME_FIELD_NUMBER

public static final int AGENT_NAME_FIELD_NUMBER
Field Value
Type Description
int

CONFIRMATION_ID_FIELD_NUMBER

public static final int CONFIRMATION_ID_FIELD_NUMBER
Field Value
Type Description
int

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

NEGATIVE_LABEL_FIELD_NUMBER

public static final int NEGATIVE_LABEL_FIELD_NUMBER
Field Value
Type Description
int

POSITIVE_LABEL_FIELD_NUMBER

public static final int POSITIVE_LABEL_FIELD_NUMBER
Field Value
Type Description
int

QUESTIONS_FIELD_NUMBER

public static final int QUESTIONS_FIELD_NUMBER
Field Value
Type Description
int

TOOL_FIELD_NUMBER

public static final int TOOL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AssistantConfirmationRequest getDefaultInstance()
Returns
Type Description
AssistantConfirmationRequest

getDescriptor()

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

newBuilder()

public static AssistantConfirmationRequest.Builder newBuilder()
Returns
Type Description
AssistantConfirmationRequest.Builder

newBuilder(AssistantConfirmationRequest prototype)

public static AssistantConfirmationRequest.Builder newBuilder(AssistantConfirmationRequest prototype)
Parameter
Name Description
prototype AssistantConfirmationRequest
Returns
Type Description
AssistantConfirmationRequest.Builder

parseDelimitedFrom(InputStream input)

public static AssistantConfirmationRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AssistantConfirmationRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AssistantConfirmationRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantConfirmationRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AssistantConfirmationRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AssistantConfirmationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AssistantConfirmationRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantConfirmationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AssistantConfirmationRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AssistantConfirmationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AssistantConfirmationRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantConfirmationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AssistantConfirmationRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AssistantConfirmationRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AssistantConfirmationRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantConfirmationRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AssistantConfirmationRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AssistantConfirmationRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AssistantConfirmationRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantConfirmationRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AssistantConfirmationRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AssistantConfirmationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AssistantConfirmationRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantConfirmationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AssistantConfirmationRequest> parser()
Returns
Type Description
Parser<AssistantConfirmationRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAgentName()

public String getAgentName()

Display label of the agent that raised the confirmation (e.g. "Contract Architect"), for the card header.

string agent_name = 7;

Returns
Type Description
String

The agentName.

getAgentNameBytes()

public ByteString getAgentNameBytes()

Display label of the agent that raised the confirmation (e.g. "Contract Architect"), for the card header.

string agent_name = 7;

Returns
Type Description
ByteString

The bytes for agentName.

getConfirmationId()

public String getConfirmationId()

Identifier correlating this request with its response. Opaque to clients; must be echoed verbatim on the answering request.

string confirmation_id = 1;

Returns
Type Description
String

The confirmationId.

getConfirmationIdBytes()

public ByteString getConfirmationIdBytes()

Identifier correlating this request with its response. Opaque to clients; must be echoed verbatim on the answering request.

string confirmation_id = 1;

Returns
Type Description
ByteString

The bytes for confirmationId.

getContext()

public String getContext()

Context describing what is being confirmed (e.g. the action the agent wants to take, or the question it needs answered). Rendered as plain text, not Markdown.

string context = 2;

Returns
Type Description
String

The context.

getContextBytes()

public ByteString getContextBytes()

Context describing what is being confirmed (e.g. the action the agent wants to take, or the question it needs answered). Rendered as plain text, not Markdown.

string context = 2;

Returns
Type Description
ByteString

The bytes for context.

getDefaultInstanceForType()

public AssistantConfirmationRequest getDefaultInstanceForType()
Returns
Type Description
AssistantConfirmationRequest

getExpireTime()

public Timestamp getExpireTime()

Time after which this confirmation can no longer be answered. An expired card renders as inactive, and the server declines the confirmation on the next turn so the paused agent does not wait indefinitely.

.google.protobuf.Timestamp expire_time = 8;

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

Time after which this confirmation can no longer be answered. An expired card renders as inactive, and the server declines the confirmation on the next turn so the paused agent does not wait indefinitely.

.google.protobuf.Timestamp expire_time = 8;

Returns
Type Description
TimestampOrBuilder

getNegativeLabel()

public String getNegativeLabel()

Label for the declining action of a binary confirmation (e.g. "Not yet"). Unset when questions is populated.

string negative_label = 4;

Returns
Type Description
String

The negativeLabel.

getNegativeLabelBytes()

public ByteString getNegativeLabelBytes()

Label for the declining action of a binary confirmation (e.g. "Not yet"). Unset when questions is populated.

string negative_label = 4;

Returns
Type Description
ByteString

The bytes for negativeLabel.

getParserForType()

public Parser<AssistantConfirmationRequest> getParserForType()
Returns
Type Description
Parser<AssistantConfirmationRequest>
Overrides

getPositiveLabel()

public String getPositiveLabel()

Label for the approving action of a binary confirmation (e.g. "Publish"). Unset when questions is populated.

string positive_label = 3;

Returns
Type Description
String

The positiveLabel.

getPositiveLabelBytes()

public ByteString getPositiveLabelBytes()

Label for the approving action of a binary confirmation (e.g. "Publish"). Unset when questions is populated.

string positive_label = 3;

Returns
Type Description
ByteString

The bytes for positiveLabel.

getQuestions(int index)

public OptionQuestionsChunk.Question getQuestions(int index)

Multi-choice form of the confirmation. When populated, the card renders a selectable option list and the chosen option's submit_text (or free-form user text) is returned as AssistantConfirmationResponse.answer_text.

repeated .google.cloud.ces.v1beta.OptionQuestionsChunk.Question questions = 5;

Parameter
Name Description
index int
Returns
Type Description
OptionQuestionsChunk.Question

getQuestionsCount()

public int getQuestionsCount()

Multi-choice form of the confirmation. When populated, the card renders a selectable option list and the chosen option's submit_text (or free-form user text) is returned as AssistantConfirmationResponse.answer_text.

repeated .google.cloud.ces.v1beta.OptionQuestionsChunk.Question questions = 5;

Returns
Type Description
int

getQuestionsList()

public List<OptionQuestionsChunk.Question> getQuestionsList()

Multi-choice form of the confirmation. When populated, the card renders a selectable option list and the chosen option's submit_text (or free-form user text) is returned as AssistantConfirmationResponse.answer_text.

repeated .google.cloud.ces.v1beta.OptionQuestionsChunk.Question questions = 5;

Returns
Type Description
List<Question>

getQuestionsOrBuilder(int index)

public OptionQuestionsChunk.QuestionOrBuilder getQuestionsOrBuilder(int index)

Multi-choice form of the confirmation. When populated, the card renders a selectable option list and the chosen option's submit_text (or free-form user text) is returned as AssistantConfirmationResponse.answer_text.

repeated .google.cloud.ces.v1beta.OptionQuestionsChunk.Question questions = 5;

Parameter
Name Description
index int
Returns
Type Description
OptionQuestionsChunk.QuestionOrBuilder

getQuestionsOrBuilderList()

public List<? extends OptionQuestionsChunk.QuestionOrBuilder> getQuestionsOrBuilderList()

Multi-choice form of the confirmation. When populated, the card renders a selectable option list and the chosen option's submit_text (or free-form user text) is returned as AssistantConfirmationResponse.answer_text.

repeated .google.cloud.ces.v1beta.OptionQuestionsChunk.Question questions = 5;

Returns
Type Description
List<? extends com.google.cloud.ces.v1beta.OptionQuestionsChunk.QuestionOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTool()

public String getTool()

Name of the tool call the agent paused on (e.g. "update_app"), for the card header. Unset for pure questions.

string tool = 6;

Returns
Type Description
String

The tool.

getToolBytes()

public ByteString getToolBytes()

Name of the tool call the agent paused on (e.g. "update_app"), for the card header. Unset for pure questions.

string tool = 6;

Returns
Type Description
ByteString

The bytes for tool.

hasExpireTime()

public boolean hasExpireTime()

Time after which this confirmation can no longer be answered. An expired card renders as inactive, and the server declines the confirmation on the next turn so the paused agent does not wait indefinitely.

.google.protobuf.Timestamp expire_time = 8;

Returns
Type Description
boolean

Whether the expireTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AssistantConfirmationRequest.Builder newBuilderForType()
Returns
Type Description
AssistantConfirmationRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AssistantConfirmationRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AssistantConfirmationRequest.Builder
Overrides

toBuilder()

public AssistantConfirmationRequest.Builder toBuilder()
Returns
Type Description
AssistantConfirmationRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException