Interface ToolOrBuilder (0.56.0)

Version 0.56.0

• 0.64.0 (latest)
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

public interface ToolOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActions(int index) (deprecated)

public abstract String getActions(int index)

Deprecated. google.cloud.dialogflow.cx.v3beta1.Tool.actions is deprecated. See google/cloud/dialogflow/cx/v3beta1/tool.proto;l=458

The list of derived action names for the tool.

repeated string actions = 6 [deprecated = true];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The actions at the given index.

getActionsBytes(int index) (deprecated)

public abstract ByteString getActionsBytes(int index)

Deprecated. google.cloud.dialogflow.cx.v3beta1.Tool.actions is deprecated. See google/cloud/dialogflow/cx/v3beta1/tool.proto;l=458

The list of derived action names for the tool.

repeated string actions = 6 [deprecated = true];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the actions at the given index.

getActionsCount() (deprecated)

public abstract int getActionsCount()

Deprecated. google.cloud.dialogflow.cx.v3beta1.Tool.actions is deprecated. See google/cloud/dialogflow/cx/v3beta1/tool.proto;l=458

The list of derived action names for the tool.

repeated string actions = 6 [deprecated = true];

Returns
Type	Description
int	The count of actions.

getActionsList() (deprecated)

public abstract List<String> getActionsList()

Deprecated. google.cloud.dialogflow.cx.v3beta1.Tool.actions is deprecated. See google/cloud/dialogflow/cx/v3beta1/tool.proto;l=458

The list of derived action names for the tool.

repeated string actions = 6 [deprecated = true];

Returns
Type	Description
List<String>	A list containing the actions.

getDataStoreSpec()

public abstract Tool.DataStoreTool getDataStoreSpec()

Data store search tool specification.

.google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreTool data_store_spec = 8;

Returns
Type	Description
Tool.DataStoreTool	The dataStoreSpec.

getDataStoreSpecOrBuilder()

public abstract Tool.DataStoreToolOrBuilder getDataStoreSpecOrBuilder()

Data store search tool specification.

.google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreTool data_store_spec = 8;

Returns
Type	Description
Tool.DataStoreToolOrBuilder

getDescription()

public abstract String getDescription()

Required. High level description of the Tool and its usage.

string description = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Required. High level description of the Tool and its usage.

string description = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. The human-readable name of the Tool, unique within an agent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The human-readable name of the Tool, unique within an agent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getExtensionSpec()

public abstract Tool.ExtensionTool getExtensionSpec()

Vertex extension tool specification.

.google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionTool extension_spec = 11;

Returns
Type	Description
Tool.ExtensionTool	The extensionSpec.

getExtensionSpecOrBuilder()

public abstract Tool.ExtensionToolOrBuilder getExtensionSpecOrBuilder()

Vertex extension tool specification.

.google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionTool extension_spec = 11;

Returns
Type	Description
Tool.ExtensionToolOrBuilder

getFunctionSpec()

public abstract Tool.FunctionTool getFunctionSpec()

Client side executed function specification.

.google.cloud.dialogflow.cx.v3beta1.Tool.FunctionTool function_spec = 13;

Returns
Type	Description
Tool.FunctionTool	The functionSpec.

getFunctionSpecOrBuilder()

public abstract Tool.FunctionToolOrBuilder getFunctionSpecOrBuilder()

Client side executed function specification.

.google.cloud.dialogflow.cx.v3beta1.Tool.FunctionTool function_spec = 13;

Returns
Type	Description
Tool.FunctionToolOrBuilder

getName()

public abstract String getName()

The unique identifier of the Tool. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/tools/<Tool ID>.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

The unique identifier of the Tool. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/tools/<Tool ID>.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getOpenApiSpec()

public abstract Tool.OpenApiTool getOpenApiSpec()

OpenAPI specification of the Tool.

.google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiTool open_api_spec = 4;

Returns
Type	Description
Tool.OpenApiTool	The openApiSpec.

getOpenApiSpecOrBuilder()

public abstract Tool.OpenApiToolOrBuilder getOpenApiSpecOrBuilder()

OpenAPI specification of the Tool.

.google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiTool open_api_spec = 4;

Returns
Type	Description
Tool.OpenApiToolOrBuilder

getSchemas(int index) (deprecated)

public abstract String getSchemas(int index)

Deprecated. google.cloud.dialogflow.cx.v3beta1.Tool.schemas is deprecated. See google/cloud/dialogflow/cx/v3beta1/tool.proto;l=461

The list of derived type schemas for the tool.

repeated string schemas = 7 [deprecated = true];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The schemas at the given index.

getSchemasBytes(int index) (deprecated)

public abstract ByteString getSchemasBytes(int index)

Deprecated. google.cloud.dialogflow.cx.v3beta1.Tool.schemas is deprecated. See google/cloud/dialogflow/cx/v3beta1/tool.proto;l=461

The list of derived type schemas for the tool.

repeated string schemas = 7 [deprecated = true];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the schemas at the given index.

getSchemasCount() (deprecated)

public abstract int getSchemasCount()

Deprecated. google.cloud.dialogflow.cx.v3beta1.Tool.schemas is deprecated. See google/cloud/dialogflow/cx/v3beta1/tool.proto;l=461

The list of derived type schemas for the tool.

repeated string schemas = 7 [deprecated = true];

Returns
Type	Description
int	The count of schemas.

getSchemasList() (deprecated)

public abstract List<String> getSchemasList()

Deprecated. google.cloud.dialogflow.cx.v3beta1.Tool.schemas is deprecated. See google/cloud/dialogflow/cx/v3beta1/tool.proto;l=461

The list of derived type schemas for the tool.

repeated string schemas = 7 [deprecated = true];

Returns
Type	Description
List<String>	A list containing the schemas.

getSpecificationCase()

public abstract Tool.SpecificationCase getSpecificationCase()

Returns
Type	Description
Tool.SpecificationCase

getToolType()

public abstract Tool.ToolType getToolType()

Output only. The tool type.

.google.cloud.dialogflow.cx.v3beta1.Tool.ToolType tool_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Tool.ToolType	The toolType.

getToolTypeValue()

public abstract int getToolTypeValue()

Output only. The tool type.

.google.cloud.dialogflow.cx.v3beta1.Tool.ToolType tool_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for toolType.

hasDataStoreSpec()

public abstract boolean hasDataStoreSpec()

Data store search tool specification.

.google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreTool data_store_spec = 8;

Returns
Type	Description
boolean	Whether the dataStoreSpec field is set.

hasExtensionSpec()

public abstract boolean hasExtensionSpec()

Vertex extension tool specification.

.google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionTool extension_spec = 11;

Returns
Type	Description
boolean	Whether the extensionSpec field is set.

hasFunctionSpec()

public abstract boolean hasFunctionSpec()

Client side executed function specification.

.google.cloud.dialogflow.cx.v3beta1.Tool.FunctionTool function_spec = 13;

Returns
Type	Description
boolean	Whether the functionSpec field is set.

hasOpenApiSpec()

public abstract boolean hasOpenApiSpec()

OpenAPI specification of the Tool.

.google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiTool open_api_spec = 4;

Returns
Type	Description
boolean	Whether the openApiSpec field is set.