Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ToolspecOverride.
Customer-facing view of the admin-curated toolspec for a BAP connection. Holds the (simplified) per-tool definitions surfaced to and editable by the admin in the Discovery Engine UI.
Mirrors the shape of the backend
google.cloud.connectorexecution.v1.ToolspecOverride message, but
is intentionally kept as a separate public type so the Discovery
Engine API surface can evolve independently of the fed-API surface
(AIP-215). Handlers convert between the two via helpers in
//cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util.
Generated from protobuf message google.cloud.discoveryengine.v1.BAPConfig.ToolspecOverride
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ BAPConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ tools |
array<Google\Protobuf\Struct>
Required. Tool definitions (one Struct per tool) that the admin has customised on top of the base toolspec returned by the fed API. REQUIRED because it is the only user-editable field in the modify API; the request must carry at least one tool. |
↳ base_version |
string
Required. Base toolspec version against which |
getTools
Required. Tool definitions (one Struct per tool) that the admin has customised on top of the base toolspec returned by the fed API.
REQUIRED because it is the only user-editable field in the modify API; the request must carry at least one tool.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Google\Protobuf\Struct> |
|
setTools
Required. Tool definitions (one Struct per tool) that the admin has customised on top of the base toolspec returned by the fed API.
REQUIRED because it is the only user-editable field in the modify API; the request must carry at least one tool.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Protobuf\Struct>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBaseVersion
Required. Base toolspec version against which tools were authored. On
Update, MUST match the server's current stable toolspec version
for the connection; mismatch is rejected with a user-facing error
directing the admin to re-download the latest tools first.
| Returns | |
|---|---|
| Type | Description |
string |
|
setBaseVersion
Required. Base toolspec version against which tools were authored. On
Update, MUST match the server's current stable toolspec version
for the connection; mismatch is rejected with a user-facing error
directing the admin to re-download the latest tools first.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|