Interface AssistantConfirmationRequestOrBuilder (0.19.0)

public interface AssistantConfirmationRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAgentName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getExpireTime()

public abstract 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 abstract 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 abstract 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 abstract 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.

getPositiveLabel()

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

getTool()

public abstract 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 abstract 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 abstract 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.