Class SuggestionInput.Builder (4.87.0)

public static final class SuggestionInput.Builder extends GeneratedMessageV3.Builder<SuggestionInput.Builder> implements SuggestionInputOrBuilder

Represents the action to take for a tool call that requires confirmation.

Protobuf type google.cloud.dialogflow.v2beta1.SuggestionInput

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SuggestionInput build()
Returns
Type Description
SuggestionInput

buildPartial()

public SuggestionInput buildPartial()
Returns
Type Description
SuggestionInput

clear()

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

clearAction()

public SuggestionInput.Builder clearAction()

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

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

Returns
Type Description
SuggestionInput.Builder

This builder for chaining.

clearAnswerRecord()

public SuggestionInput.Builder clearAnswerRecord()

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

string answer_record = 1;

Returns
Type Description
SuggestionInput.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearIntentInput()

public SuggestionInput.Builder clearIntentInput()

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 6;

Returns
Type Description
SuggestionInput.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParameters()

public SuggestionInput.Builder clearParameters()

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

.google.protobuf.Struct parameters = 4;

Returns
Type Description
SuggestionInput.Builder

clearSendTime()

public SuggestionInput.Builder clearSendTime()

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

clearTextOverride()

public SuggestionInput.Builder clearTextOverride()

Optional. If the customer edited the suggestion before using it, include the revised text here.

.google.cloud.dialogflow.v2beta1.TextInput text_override = 2;

Returns
Type Description
SuggestionInput.Builder

clone()

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

getAction()

public SuggestionInput.Action getAction()

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

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

Returns
Type Description
SuggestionInput.Action

The action.

getActionValue()

public int getActionValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for action.

getAnswerRecord()

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

Returns
Type Description
String

The answerRecord.

getAnswerRecordBytes()

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

Returns
Type Description
ByteString

The bytes for answerRecord.

getDefaultInstanceForType()

public SuggestionInput getDefaultInstanceForType()
Returns
Type Description
SuggestionInput

getDescriptorForType()

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

getIntentInput()

public IntentInput getIntentInput()

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 6;

Returns
Type Description
IntentInput

The intentInput.

getIntentInputBuilder()

public IntentInput.Builder getIntentInputBuilder()

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 6;

Returns
Type Description
IntentInput.Builder

getIntentInputOrBuilder()

public IntentInputOrBuilder getIntentInputOrBuilder()

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 6;

Returns
Type Description
IntentInputOrBuilder

getParameters()

public Struct getParameters()

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

.google.protobuf.Struct parameters = 4;

Returns
Type Description
Struct

The parameters.

getParametersBuilder()

public Struct.Builder getParametersBuilder()

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

.google.protobuf.Struct parameters = 4;

Returns
Type Description
Builder

getParametersOrBuilder()

public StructOrBuilder getParametersOrBuilder()

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

.google.protobuf.Struct parameters = 4;

Returns
Type Description
StructOrBuilder

getSendTime()

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

getSendTimeBuilder()

public Timestamp.Builder getSendTimeBuilder()

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
Builder

getSendTimeOrBuilder()

public 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

getTextOverride()

public TextInput getTextOverride()

Optional. If the customer edited the suggestion before using it, include the revised text here.

.google.cloud.dialogflow.v2beta1.TextInput text_override = 2;

Returns
Type Description
TextInput

The textOverride.

getTextOverrideBuilder()

public TextInput.Builder getTextOverrideBuilder()

Optional. If the customer edited the suggestion before using it, include the revised text here.

.google.cloud.dialogflow.v2beta1.TextInput text_override = 2;

Returns
Type Description
TextInput.Builder

getTextOverrideOrBuilder()

public TextInputOrBuilder getTextOverrideOrBuilder()

Optional. If the customer edited the suggestion before using it, include the revised text here.

.google.cloud.dialogflow.v2beta1.TextInput text_override = 2;

Returns
Type Description
TextInputOrBuilder

hasIntentInput()

public boolean hasIntentInput()

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 6;

Returns
Type Description
boolean

Whether the intentInput field is set.

hasParameters()

public boolean hasParameters()

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

.google.protobuf.Struct parameters = 4;

Returns
Type Description
boolean

Whether the parameters field is set.

hasSendTime()

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

hasTextOverride()

public boolean hasTextOverride()

Optional. If the customer edited the suggestion before using it, include the revised text here.

.google.cloud.dialogflow.v2beta1.TextInput text_override = 2;

Returns
Type Description
boolean

Whether the textOverride field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SuggestionInput other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeIntentInput(IntentInput value)

public SuggestionInput.Builder mergeIntentInput(IntentInput value)

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 6;

Parameter
Name Description
value IntentInput
Returns
Type Description
SuggestionInput.Builder

mergeParameters(Struct value)

public SuggestionInput.Builder mergeParameters(Struct value)

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

.google.protobuf.Struct parameters = 4;

Parameter
Name Description
value Struct
Returns
Type Description
SuggestionInput.Builder

mergeSendTime(Timestamp value)

public SuggestionInput.Builder mergeSendTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SuggestionInput.Builder

mergeTextOverride(TextInput value)

public SuggestionInput.Builder mergeTextOverride(TextInput value)

Optional. If the customer edited the suggestion before using it, include the revised text here.

.google.cloud.dialogflow.v2beta1.TextInput text_override = 2;

Parameter
Name Description
value TextInput
Returns
Type Description
SuggestionInput.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAction(SuggestionInput.Action value)

public SuggestionInput.Builder setAction(SuggestionInput.Action value)

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

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

Parameter
Name Description
value SuggestionInput.Action

The action to set.

Returns
Type Description
SuggestionInput.Builder

This builder for chaining.

setActionValue(int value)

public SuggestionInput.Builder setActionValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for action to set.

Returns
Type Description
SuggestionInput.Builder

This builder for chaining.

setAnswerRecord(String value)

public SuggestionInput.Builder setAnswerRecord(String value)

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

string answer_record = 1;

Parameter
Name Description
value String

The answerRecord to set.

Returns
Type Description
SuggestionInput.Builder

This builder for chaining.

setAnswerRecordBytes(ByteString value)

public SuggestionInput.Builder setAnswerRecordBytes(ByteString value)

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

string answer_record = 1;

Parameter
Name Description
value ByteString

The bytes for answerRecord to set.

Returns
Type Description
SuggestionInput.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setIntentInput(IntentInput value)

public SuggestionInput.Builder setIntentInput(IntentInput value)

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 6;

Parameter
Name Description
value IntentInput
Returns
Type Description
SuggestionInput.Builder

setIntentInput(IntentInput.Builder builderForValue)

public SuggestionInput.Builder setIntentInput(IntentInput.Builder builderForValue)

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 6;

Parameter
Name Description
builderForValue IntentInput.Builder
Returns
Type Description
SuggestionInput.Builder

setParameters(Struct value)

public SuggestionInput.Builder setParameters(Struct value)

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

.google.protobuf.Struct parameters = 4;

Parameter
Name Description
value Struct
Returns
Type Description
SuggestionInput.Builder

setParameters(Struct.Builder builderForValue)

public SuggestionInput.Builder setParameters(Struct.Builder builderForValue)

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

.google.protobuf.Struct parameters = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SuggestionInput.Builder

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

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

setSendTime(Timestamp value)

public SuggestionInput.Builder setSendTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SuggestionInput.Builder

setSendTime(Timestamp.Builder builderForValue)

public SuggestionInput.Builder setSendTime(Timestamp.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SuggestionInput.Builder

setTextOverride(TextInput value)

public SuggestionInput.Builder setTextOverride(TextInput value)

Optional. If the customer edited the suggestion before using it, include the revised text here.

.google.cloud.dialogflow.v2beta1.TextInput text_override = 2;

Parameter
Name Description
value TextInput
Returns
Type Description
SuggestionInput.Builder

setTextOverride(TextInput.Builder builderForValue)

public SuggestionInput.Builder setTextOverride(TextInput.Builder builderForValue)

Optional. If the customer edited the suggestion before using it, include the revised text here.

.google.cloud.dialogflow.v2beta1.TextInput text_override = 2;

Parameter
Name Description
builderForValue TextInput.Builder
Returns
Type Description
SuggestionInput.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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