Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Interface ToolOrBuilder (0.78.0)

public interface ToolOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConnectorSpec()

public abstract Tool.ConnectorTool getConnectorSpec()

Integration connectors tool specification.

.google.cloud.dialogflow.cx.v3beta1.Tool.ConnectorTool connector_spec = 15;

Returns
Type	Description
`Tool.ConnectorTool`	The connectorSpec.

getConnectorSpecOrBuilder()

public abstract Tool.ConnectorToolOrBuilder getConnectorSpecOrBuilder()

Integration connectors tool specification.

.google.cloud.dialogflow.cx.v3beta1.Tool.ConnectorTool connector_spec = 15;

Returns
Type	Description
`Tool.ConnectorToolOrBuilder`

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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

string name = 1;

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

The unique identifier of the Tool. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

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`

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.

hasConnectorSpec()

public abstract boolean hasConnectorSpec()

Integration connectors tool specification.

.google.cloud.dialogflow.cx.v3beta1.Tool.ConnectorTool connector_spec = 15;

Returns
Type	Description
`boolean`	Whether the connectorSpec field is set.

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.