ADK for TypeScript: API Reference
    Preparing search index...

    Class IntegrationConnectorTool

    Wraps a RestApiTool for an Integration Connectors operation, hiding connection and routing fields from the model declaration and injecting them when the tool runs.

    Hierarchy (View Summary)

    "[BASE_TOOL_SIGNATURE_SYMBOL]": true

    A unique symbol to identify ADK base tool class.

    action: string
    authCredential?: AuthCredential
    authScheme?: AuthScheme
    connectionHost: string
    connectionName: string
    connectionServiceName: string
    description: string
    entity: string
    isLongRunning: boolean
    name: string
    operation: string
    restApiTool: RestApiTool
    EXCLUDE_FIELDS: readonly string[] = ...

    Request fields that IntegrationConnectorTool injects at runtime and excludes from the function declaration shown to the model.

    OPTIONAL_FIELDS: readonly string[] = ...

    Request fields that IntegrationConnectorTool removes from the required list in the function declaration shown to the model.

    • Whether this tool needs a human to approve args before it runs.

      The gate itself lives in the tool that owns it (see FunctionTool), but the resume path has to ask the same question a turn later, to check that an approval it is about to honour belongs to a tool that gates at all. A tool that never gates returns false here, which is the safe default: an approval naming it is meaningless and gets rejected rather than executed. Mirrors Python's BaseTool.check_require_confirmation.

      Parameters

      • _args: Record<string, unknown>

        The arguments the tool would run with.

      • Optional_toolContext: Context

        The context of the call, when there is one.

      Returns Promise<boolean>

      Whether the call requires confirmation.