com.google.cloud.dialogflow.cx.v3beta1

Interface ToolOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Tool, Tool.Builder

public interface ToolOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Tool.ConnectorTool	getConnectorSpec() Integration connectors tool specification.
Tool.ConnectorToolOrBuilder	getConnectorSpecOrBuilder() Integration connectors tool specification.
Tool.DataStoreTool	getDataStoreSpec() Data store search tool specification.
Tool.DataStoreToolOrBuilder	getDataStoreSpecOrBuilder() Data store search tool specification.
String	getDescription() Required.
com.google.protobuf.ByteString	getDescriptionBytes() Required.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
Tool.ExtensionTool	getExtensionSpec() Vertex extension tool specification.
Tool.ExtensionToolOrBuilder	getExtensionSpecOrBuilder() Vertex extension tool specification.
Tool.FunctionTool	getFunctionSpec() Client side executed function specification.
Tool.FunctionToolOrBuilder	getFunctionSpecOrBuilder() Client side executed function specification.
String	getName() The unique identifier of the Tool.
com.google.protobuf.ByteString	getNameBytes() The unique identifier of the Tool.
Tool.OpenApiTool	getOpenApiSpec() OpenAPI specification of the Tool.
Tool.OpenApiToolOrBuilder	getOpenApiSpecOrBuilder() OpenAPI specification of the Tool.
Tool.SpecificationCase	getSpecificationCase()
Tool.ToolType	getToolType() Output only.
int	getToolTypeValue() Output only.
boolean	hasConnectorSpec() Integration connectors tool specification.
boolean	hasDataStoreSpec() Data store search tool specification.
boolean	hasExtensionSpec() Vertex extension tool specification.
boolean	hasFunctionSpec() Client side executed function specification.
boolean	hasOpenApiSpec() OpenAPI specification of the Tool.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

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

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

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

string name = 1;

Returns:

The bytes for name.

getDisplayName

String getDisplayName()

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

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

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

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

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

Returns:

The bytes for displayName.

getDescription

String getDescription()

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

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

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

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

Returns:

The bytes for description.

hasOpenApiSpec

boolean hasOpenApiSpec()

 OpenAPI specification of the Tool.
 

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

Returns:

Whether the openApiSpec field is set.

getOpenApiSpec

Tool.OpenApiTool getOpenApiSpec()

 OpenAPI specification of the Tool.
 

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

Returns:

The openApiSpec.

getOpenApiSpecOrBuilder

Tool.OpenApiToolOrBuilder getOpenApiSpecOrBuilder()

 OpenAPI specification of the Tool.
 

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

hasDataStoreSpec

boolean hasDataStoreSpec()

 Data store search tool specification.
 

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

Returns:

Whether the dataStoreSpec field is set.

getDataStoreSpec

Tool.DataStoreTool getDataStoreSpec()

 Data store search tool specification.
 

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

Returns:

The dataStoreSpec.

getDataStoreSpecOrBuilder

Tool.DataStoreToolOrBuilder getDataStoreSpecOrBuilder()

 Data store search tool specification.
 

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

hasExtensionSpec

boolean hasExtensionSpec()

 Vertex extension tool specification.
 

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

Returns:

Whether the extensionSpec field is set.

getExtensionSpec

Tool.ExtensionTool getExtensionSpec()

 Vertex extension tool specification.
 

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

Returns:

The extensionSpec.

getExtensionSpecOrBuilder

Tool.ExtensionToolOrBuilder getExtensionSpecOrBuilder()

 Vertex extension tool specification.
 

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

hasFunctionSpec

boolean hasFunctionSpec()

 Client side executed function specification.
 

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

Returns:

Whether the functionSpec field is set.

getFunctionSpec

Tool.FunctionTool getFunctionSpec()

 Client side executed function specification.
 

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

Returns:

The functionSpec.

getFunctionSpecOrBuilder

Tool.FunctionToolOrBuilder getFunctionSpecOrBuilder()

 Client side executed function specification.
 

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

hasConnectorSpec

boolean hasConnectorSpec()

 Integration connectors tool specification.
 

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

Returns:

Whether the connectorSpec field is set.

getConnectorSpec

Tool.ConnectorTool getConnectorSpec()

 Integration connectors tool specification.
 

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

Returns:

The connectorSpec.

getConnectorSpecOrBuilder

Tool.ConnectorToolOrBuilder getConnectorSpecOrBuilder()

 Integration connectors tool specification.
 

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

getToolTypeValue

int getToolTypeValue()

 Output only. The tool type.
 

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

Returns:

The enum numeric value on the wire for toolType.

getToolType

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:

The toolType.

getSpecificationCase

Tool.SpecificationCase getSpecificationCase()