Represents a Tool.
Package
@google-cloud/cesConstructors
(constructor)(properties)
constructor
(
properties
?:
google
.
cloud
.
ces
.
v1
.
ITool
);
Constructs a new Tool.
Properties
agentTool
public
agentTool
?:
(
google
.
cloud
.
ces
.
v1
.
IAgentTool
|
null
);
Tool agentTool.
clientFunction
public
clientFunction
?:
(
google
.
cloud
.
ces
.
v1
.
IClientFunction
|
null
);
Tool clientFunction.
connectorTool
public
connectorTool
?:
(
google
.
cloud
.
ces
.
v1
.
IConnectorTool
|
null
);
Tool connectorTool.
createTime
public
createTime
?:
(
google
.
protobuf
.
ITimestamp
|
null
);
Tool createTime.
dataStoreTool
public
dataStoreTool
?:
(
google
.
cloud
.
ces
.
v1
.
IDataStoreTool
|
null
);
Tool dataStoreTool.
displayName
public
displayName
:
string
;
Tool displayName.
etag
public
etag
:
string
;
Tool etag.
executionType
public
executionType
:
(
google
.
cloud
.
ces
.
v1
.
ExecutionType
|
keyof
typeof
google
.
cloud
.
ces
.
v1
.
ExecutionType
);
Tool executionType.
fileSearchTool
public
fileSearchTool
?:
(
google
.
cloud
.
ces
.
v1
.
IFileSearchTool
|
null
);
Tool fileSearchTool.
generatedSummary
public
generatedSummary
:
string
;
Tool generatedSummary.
googleSearchTool
public
googleSearchTool
?:
(
google
.
cloud
.
ces
.
v1
.
IGoogleSearchTool
|
null
);
Tool googleSearchTool.
mcpTool
public
mcpTool
?:
(
google
.
cloud
.
ces
.
v1
.
IMcpTool
|
null
);
Tool mcpTool.
name
public
name
:
string
;
Tool name.
openApiTool
public
openApiTool
?:
(
google
.
cloud
.
ces
.
v1
.
IOpenApiTool
|
null
);
Tool openApiTool.
pythonFunction
public
pythonFunction
?:
(
google
.
cloud
.
ces
.
v1
.
IPythonFunction
|
null
);
Tool pythonFunction.
systemTool
public
systemTool
?:
(
google
.
cloud
.
ces
.
v1
.
ISystemTool
|
null
);
Tool systemTool.
toolFakeConfig
public
toolFakeConfig
?:
(
google
.
cloud
.
ces
.
v1
.
IToolFakeConfig
|
null
);
Tool toolFakeConfig.
toolType
public
toolType
?:
(
"clientFunction"
|
"openApiTool"
|
"googleSearchTool"
|
"connectorTool"
|
"dataStoreTool"
|
"pythonFunction"
|
"mcpTool"
|
"fileSearchTool"
|
"systemTool"
|
"agentTool"
|
"widgetTool"
);
Tool toolType.
updateTime
public
updateTime
?:
(
google
.
protobuf
.
ITimestamp
|
null
);
Tool updateTime.
widgetTool
public
widgetTool
?:
(
google
.
cloud
.
ces
.
v1
.
IWidgetTool
|
null
);
Tool widgetTool.
Methods
create(properties)
public
static
create
(
properties
?:
google
.
cloud
.
ces
.
v1
.
ITool
)
:
google
.
cloud
.
ces
.
v1
.
Tool
;
Creates a new Tool instance using the specified properties.
decode(reader, length)
public
static
decode
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
),
length
?:
number
)
:
google
.
cloud
.
ces
.
v1
.
Tool
;
Decodes a Tool message from the specified reader or buffer.
reader
( Reader
| Uint8Array
)
Reader or buffer to decode from
length
number
Message length if known beforehand
decodeDelimited(reader)
public
static
decodeDelimited
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
))
:
google
.
cloud
.
ces
.
v1
.
Tool
;
Decodes a Tool message from the specified reader or buffer, length delimited.
reader
( Reader
| Uint8Array
)
Reader or buffer to decode from
encode(message, writer)
public
static
encode
(
message
:
google
.
cloud
.
ces
.
v1
.
ITool
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified Tool message. Does not implicitly messages.
message
writer
$protobuf.Writer
Writer to encode to
$protobuf.Writer
Writer
encodeDelimited(message, writer)
public
static
encodeDelimited
(
message
:
google
.
cloud
.
ces
.
v1
.
ITool
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified Tool message, length delimited. Does not implicitly messages.
message
writer
$protobuf.Writer
Writer to encode to
$protobuf.Writer
Writer
fromObject(object)
public
static
fromObject
(
object
:
{
[
k
:
string
]
:
any
})
:
google
.
cloud
.
ces
.
v1
.
Tool
;
Creates a Tool message from a plain object. Also converts values to their respective internal types.
object
{ [k: string]: any }
Plain object
getTypeUrl(typeUrlPrefix)
public
static
getTypeUrl
(
typeUrlPrefix
?:
string
)
:
string
;
Gets the default type url for Tool
typeUrlPrefix
string
your custom typeUrlPrefix(default "type.googleapis.com")
string
The default type url
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this Tool to JSON.
{ [k: string]: any }
JSON object
toObject(message, options)
public
static
toObject
(
message
:
google
.
cloud
.
ces
.
v1
.
Tool
,
options
?:
$protobuf
.
IConversionOptions
)
:
{
[
k
:
string
]
:
any
};
Creates a plain object from a Tool message. Also converts values to other types if specified.
message
options
$protobuf.IConversionOptions
Conversion options
{ [k: string]: any }
Plain object
verify(message)
public
static
verify
(
message
:
{
[
k
:
string
]
:
any
})
:
(
string
|
null
);
Verifies a Tool message.
message
{ [k: string]: any }
Plain object to verify
(string|null)
null
if valid, otherwise the reason why it is not
