Constructor
new Tool(propertiesopt)
Constructs a new Tool.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.dialogflow.cx.v3beta1.ITool |
<optional> |
Properties to set |
- Implements:
-
- ITool
Classes
Members
dataStoreSpec
Tool dataStoreSpec.
description
Tool description.
displayName
Tool displayName.
extensionSpec
Tool extensionSpec.
functionSpec
Tool functionSpec.
name
Tool name.
openApiSpec
Tool openApiSpec.
specification
Tool specification.
toolType
Tool toolType.
ToolType
ToolType enum.
Properties:
| Name | Type | Description |
|---|---|---|
TOOL_TYPE_UNSPECIFIED |
number |
TOOL_TYPE_UNSPECIFIED value |
CUSTOMIZED_TOOL |
number |
CUSTOMIZED_TOOL value |
BUILTIN_TOOL |
number |
BUILTIN_TOOL value |
Methods
toJSON() → {Object.<string, *>}
Converts this Tool to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.dialogflow.cx.v3beta1.Tool}
Creates a new Tool instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.dialogflow.cx.v3beta1.ITool |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.dialogflow.cx.v3beta1.Tool |
Tool instance |
(static) decode(reader, lengthopt) → {google.cloud.dialogflow.cx.v3beta1.Tool}
Decodes a Tool message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.dialogflow.cx.v3beta1.Tool |
Tool |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.dialogflow.cx.v3beta1.Tool}
Decodes a Tool message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.dialogflow.cx.v3beta1.Tool |
Tool |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Tool message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.dialogflow.cx.v3beta1.ITool |
Tool message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Tool message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.dialogflow.cx.v3beta1.ITool |
Tool message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.dialogflow.cx.v3beta1.Tool}
Creates a Tool message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.dialogflow.cx.v3beta1.Tool |
Tool |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Tool
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Tool message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.dialogflow.cx.v3beta1.Tool |
Tool |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Tool message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|