Interface SuggestionInputOrBuilder (4.87.0)

public interface SuggestionInputOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAction()

public abstract SuggestionInput.Action getAction()

Optional. The type of action to take with the tool.

.google.cloud.dialogflow.v2.SuggestionInput.Action action = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SuggestionInput.Action

The action.

getActionValue()

public abstract int getActionValue()

Optional. The type of action to take with the tool.

.google.cloud.dialogflow.v2.SuggestionInput.Action action = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for action.

getAnswerRecord()

public abstract String getAnswerRecord()

Required. Format: projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID> The answer record associated with the tool call.

string answer_record = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The answerRecord.

getAnswerRecordBytes()

public abstract ByteString getAnswerRecordBytes()

Required. Format: projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID> The answer record associated with the tool call.

string answer_record = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for answerRecord.

getParameters()

public abstract Struct getParameters()

Optional. Parameters to be used for the tool call. If not provided, the tool will be called without any parameters.

.google.protobuf.Struct parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The parameters.

getParametersOrBuilder()

public abstract StructOrBuilder getParametersOrBuilder()

Optional. Parameters to be used for the tool call. If not provided, the tool will be called without any parameters.

.google.protobuf.Struct parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getSendTime()

public abstract Timestamp getSendTime()

Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified.

.google.protobuf.Timestamp send_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The sendTime.

getSendTimeOrBuilder()

public abstract TimestampOrBuilder getSendTimeOrBuilder()

Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified.

.google.protobuf.Timestamp send_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

hasParameters()

public abstract boolean hasParameters()

Optional. Parameters to be used for the tool call. If not provided, the tool will be called without any parameters.

.google.protobuf.Struct parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the parameters field is set.

hasSendTime()

public abstract boolean hasSendTime()

Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified.

.google.protobuf.Timestamp send_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sendTime field is set.