Interface ToolUseOrBuilder (0.52.0)

public interface ToolUseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAction()

public abstract String getAction()

Optional. Name of the action to be called during the tool use.

string action = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The action.

getActionBytes()

public abstract ByteString getActionBytes()

Optional. Name of the action to be called during the tool use.

string action = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for action.

getInputParameters(int index)

public abstract ActionParameter getInputParameters(int index)

A list of input parameters for the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;

Parameter
Name Description
index int
Returns
Type Description
ActionParameter

getInputParametersCount()

public abstract int getInputParametersCount()

A list of input parameters for the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;

Returns
Type Description
int

getInputParametersList()

public abstract List<ActionParameter> getInputParametersList()

A list of input parameters for the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;

Returns
Type Description
List<ActionParameter>

getInputParametersOrBuilder(int index)

public abstract ActionParameterOrBuilder getInputParametersOrBuilder(int index)

A list of input parameters for the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;

Parameter
Name Description
index int
Returns
Type Description
ActionParameterOrBuilder

getInputParametersOrBuilderList()

public abstract List<? extends ActionParameterOrBuilder> getInputParametersOrBuilderList()

A list of input parameters for the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ActionParameterOrBuilder>

getOutputParameters(int index)

public abstract ActionParameter getOutputParameters(int index)

A list of output parameters generated by the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;

Parameter
Name Description
index int
Returns
Type Description
ActionParameter

getOutputParametersCount()

public abstract int getOutputParametersCount()

A list of output parameters generated by the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;

Returns
Type Description
int

getOutputParametersList()

public abstract List<ActionParameter> getOutputParametersList()

A list of output parameters generated by the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;

Returns
Type Description
List<ActionParameter>

getOutputParametersOrBuilder(int index)

public abstract ActionParameterOrBuilder getOutputParametersOrBuilder(int index)

A list of output parameters generated by the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;

Parameter
Name Description
index int
Returns
Type Description
ActionParameterOrBuilder

getOutputParametersOrBuilderList()

public abstract List<? extends ActionParameterOrBuilder> getOutputParametersOrBuilderList()

A list of output parameters generated by the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ActionParameterOrBuilder>

getTool()

public abstract String getTool()

Required. The tool that should be used. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/tools/<Tool ID>.

string tool = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The tool.

getToolBytes()

public abstract ByteString getToolBytes()

Required. The tool that should be used. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/tools/<Tool ID>.

string tool = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for tool.