Files
2026-07-24 18:22:51 +00:00

342 lines
30 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Google Analytics tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-DKHZS27PHP"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag("js", new Date());
gtag("config", "G-DKHZS27PHP");
</script>
<!-- Generated by javadoc (26) -->
<title>BasePlugin (Google Agent Development Kit Maven Parent POM 1.7.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: com.google.adk.plugins, class: BasePlugin">
<meta name="generator" content="javadoc/ClassWriter">
<link rel="stylesheet" type="text/css" href="../../../../resource-files/jquery-ui.min.css">
<link rel="stylesheet" type="text/css" href="../../../../resource-files/stylesheet.css">
<script type="text/javascript" src="../../../../script-files/script.js"></script>
<script type="text/javascript" src="../../../../script-files/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../../script-files/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">const pathtoroot = "../../../../";
loadScripts();
initTheme();
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="nav-content">
<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button></div>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/BasePlugin.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../search.html">Search</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"></button></li>
</ul>
<div id="theme-panel">
<div>Select Theme</div>
<div><label for="theme-light"><input type="radio" id="theme-light" disabled name="theme" value="theme-light"><span>Light</span></label><label for="theme-dark"><input type="radio" id="theme-dark" disabled name="theme" value="theme-dark"><span>Dark</span></label><label for="theme-os"><input type="radio" id="theme-os" disabled name="theme" value="theme-os"><span>System Setting</span></label></div>
</div>
</div>
</div>
<div class="sub-nav">
<div class="nav-content">
<ol class="sub-nav-list">
<li><a href="package-summary.html">com.google.adk.plugins</a></li>
<li><a href="BasePlugin.html" class="current-selection">BasePlugin</a></li>
</ol>
<div class="nav-list-search"><input type="text" id="search-input" disabled placeholder="Search documentation (type /)" aria-label="Search in documentation" autocomplete="off" spellcheck="false"><input type="reset" id="reset-search" disabled value="Reset"></div>
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="main-grid">
<nav role="navigation" class="toc" aria-label="Table of contents">
<div class="toc-header">Contents&nbsp;<input type="text" class="filter-input" disabled placeholder="Filter contents (type .)" aria-label="Filter table of contents" autocomplete="off" spellcheck="false"><input type="reset" class="reset-filter" disabled tabindex="-1" value="Reset">&nbsp;<button class="toc-sort-toggle" id="toc-lexical-order-toggle"><img src="../../../../resource-files/sort-a-z.svg" alt="Sort member details in lexicographical order"></button></div>
<ol class="toc-list" tabindex="-1">
<li><a href="#" tabindex="0">Description</a></li>
<li><a href="#field-summary" tabindex="0">Field Summary</a></li>
<li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li>
<li><a href="#method-summary" tabindex="0">Method Summary</a></li>
<li><a href="#field-detail" tabindex="0">Field Details</a>
<ol class="toc-list">
<li><a href="#name" tabindex="0">name</a></li>
</ol>
</li>
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
<ol class="toc-list">
<li><a href="#%3Cinit%3E(java.lang.String)" tabindex="0">BasePlugin(String)</a></li>
</ol>
</li>
<li><a href="#method-detail" tabindex="0">Method Details</a>
<ol class="toc-list">
<li><a href="#getName()" tabindex="0">getName()</a></li>
</ol>
</li>
</ol>
<button class="hide-sidebar"><span>Hide sidebar&nbsp;</span><img src="../../../../resource-files/left.svg" alt="Hide sidebar"></button><button class="show-sidebar"><img src="../../../../resource-files/right.svg" alt="Show sidebar"><span>&nbsp;Show sidebar</span></button></nav>
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<h1 title="Class BasePlugin" class="title">Class BasePlugin</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">com.google.adk.plugins.BasePlugin</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="Plugin.html" title="interface in com.google.adk.plugins">Plugin</a></code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="agentanalytics/BigQueryAgentAnalyticsPlugin.html" title="class in com.google.adk.plugins.agentanalytics">BigQueryAgentAnalyticsPlugin</a>, <a href="ContextFilterPlugin.html" title="class in com.google.adk.plugins">ContextFilterPlugin</a>, <a href="GlobalInstructionPlugin.html" title="class in com.google.adk.plugins">GlobalInstructionPlugin</a>, <a href="LoggingPlugin.html" title="class in com.google.adk.plugins">LoggingPlugin</a>, <a href="PluginManager.html" title="class in com.google.adk.plugins">PluginManager</a>, <a href="ReplayPlugin.html" title="class in com.google.adk.plugins">ReplayPlugin</a></code></dd>
</dl>
<hr>
<div class="horizontal-scroll">
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">BasePlugin</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>
implements <a href="Plugin.html" title="interface in com.google.adk.plugins">Plugin</a></span></div>
<div class="block">Base class for creating plugins.
<p>Plugins provide a structured way to intercept and modify agent, tool, and LLM behaviors at
critical execution points in a callback manner. While agent callbacks apply to a particular
agent, plugins applies globally to all agents added in the runner. Plugins are best used for
adding custom behaviors like logging, monitoring, caching, or modifying requests and responses at
key stages.
<p>A plugin can implement one or more methods of callbacks, but should not implement the same
method of callback for multiple times.</div>
</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#name" class="member-name-link">name</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">BasePlugin</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color">
<div class="block">Constructs a new plugin with the given name.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary" title="class in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="clone()" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="equals(Object)" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="finalize()" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="getClass()" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="hashCode()" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="notify()" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="notifyAll()" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="toString()" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="wait()" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="wait(long)" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="wait(long, int)" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-com.google.adk.plugins.Plugin">Methods inherited from interface&nbsp;<a href="Plugin.html#method-summary" title="interface in com.google.adk.plugins">Plugin</a></h3>
<code><a href="Plugin.html#afterAgentCallback(com.google.adk.agents.BaseAgent,com.google.adk.agents.CallbackContext)" title="afterAgentCallback(BaseAgent, CallbackContext)">afterAgentCallback</a>, <a href="Plugin.html#afterModelCallback(com.google.adk.agents.CallbackContext,com.google.adk.models.LlmResponse)" title="afterModelCallback(CallbackContext, LlmResponse)">afterModelCallback</a>, <a href="Plugin.html#afterRunCallback(com.google.adk.agents.InvocationContext)" title="afterRunCallback(InvocationContext)">afterRunCallback</a>, <a href="Plugin.html#afterToolCallback(com.google.adk.tools.BaseTool,java.util.Map,com.google.adk.tools.ToolContext,java.util.Map)" title="afterToolCallback(BaseTool, Map, ToolContext, Map)">afterToolCallback</a>, <a href="Plugin.html#beforeAgentCallback(com.google.adk.agents.BaseAgent,com.google.adk.agents.CallbackContext)" title="beforeAgentCallback(BaseAgent, CallbackContext)">beforeAgentCallback</a>, <a href="Plugin.html#beforeModelCallback(com.google.adk.agents.CallbackContext,com.google.adk.models.LlmRequest.Builder)" title="beforeModelCallback(CallbackContext, LlmRequest.Builder)">beforeModelCallback</a>, <a href="Plugin.html#beforeRunCallback(com.google.adk.agents.InvocationContext)" title="beforeRunCallback(InvocationContext)">beforeRunCallback</a>, <a href="Plugin.html#beforeToolCallback(com.google.adk.tools.BaseTool,java.util.Map,com.google.adk.tools.ToolContext)" title="beforeToolCallback(BaseTool, Map, ToolContext)">beforeToolCallback</a>, <a href="Plugin.html#close()" title="close()">close</a>, <a href="Plugin.html#onEventCallback(com.google.adk.agents.InvocationContext,com.google.adk.events.Event)" title="onEventCallback(InvocationContext, Event)">onEventCallback</a>, <a href="Plugin.html#onModelErrorCallback(com.google.adk.agents.CallbackContext,com.google.adk.models.LlmRequest.Builder,java.lang.Throwable)" title="onModelErrorCallback(CallbackContext, LlmRequest.Builder, Throwable)">onModelErrorCallback</a>, <a href="Plugin.html#onToolErrorCallback(com.google.adk.tools.BaseTool,java.util.Map,com.google.adk.tools.ToolContext,java.lang.Throwable)" title="onToolErrorCallback(BaseTool, Map, ToolContext, Throwable)">onToolErrorCallback</a>, <a href="Plugin.html#onUserMessageCallback(com.google.adk.agents.InvocationContext,com.google.genai.types.Content)" title="onUserMessageCallback(InvocationContext, Content)">onUserMessageCallback</a></code>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr>&lt;com.google.genai.types.Content&gt;</code></div>
<div class="col-second even-row-color"><code><a href="Plugin.html#afterAgentCallback(com.google.adk.agents.BaseAgent,com.google.adk.agents.CallbackContext)" class="member-name-link">afterAgentCallback</a><wbr>(<a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a>&nbsp;agent,
<a href="../agents/CallbackContext.html" title="class in com.google.adk.agents">CallbackContext</a>&nbsp;callbackContext)</code></div>
<div class="col-last even-row-color">
<div class="block">Callback executed after an agent's primary logic has completed.</div>
</div>
<div class="col-first odd-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr>&lt;<a href="../models/LlmResponse.html" title="class in com.google.adk.models">LlmResponse</a>&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="Plugin.html#afterModelCallback(com.google.adk.agents.CallbackContext,com.google.adk.models.LlmResponse)" class="member-name-link">afterModelCallback</a><wbr>(<a href="../agents/CallbackContext.html" title="class in com.google.adk.agents">CallbackContext</a>&nbsp;callbackContext,
<a href="../models/LlmResponse.html" title="class in com.google.adk.models">LlmResponse</a>&nbsp;llmResponse)</code></div>
<div class="col-last odd-row-color">
<div class="block">Callback executed after a response is received from the model.</div>
</div>
<div class="col-first even-row-color"><code>default io.reactivex.rxjava3.core.Completable</code></div>
<div class="col-second even-row-color"><code><a href="Plugin.html#afterRunCallback(com.google.adk.agents.InvocationContext)" class="member-name-link">afterRunCallback</a><wbr>(<a href="../agents/InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a>&nbsp;invocationContext)</code></div>
<div class="col-last even-row-color">
<div class="block">Callback executed after an ADK runner run has completed.</div>
</div>
<div class="col-first odd-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="Plugin.html#afterToolCallback(com.google.adk.tools.BaseTool,java.util.Map,com.google.adk.tools.ToolContext,java.util.Map)" class="member-name-link">afterToolCallback</a><wbr>(<a href="../tools/BaseTool.html" title="class in com.google.adk.tools">BaseTool</a>&nbsp;tool,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;&nbsp;toolArgs,
<a href="../tools/ToolContext.html" title="class in com.google.adk.tools">ToolContext</a>&nbsp;toolContext,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;&nbsp;result)</code></div>
<div class="col-last odd-row-color">
<div class="block">Callback executed after a tool has been called.</div>
</div>
<div class="col-first even-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr>&lt;com.google.genai.types.Content&gt;</code></div>
<div class="col-second even-row-color"><code><a href="Plugin.html#beforeAgentCallback(com.google.adk.agents.BaseAgent,com.google.adk.agents.CallbackContext)" class="member-name-link">beforeAgentCallback</a><wbr>(<a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a>&nbsp;agent,
<a href="../agents/CallbackContext.html" title="class in com.google.adk.agents">CallbackContext</a>&nbsp;callbackContext)</code></div>
<div class="col-last even-row-color">
<div class="block">Callback executed before an agent's primary logic is invoked.</div>
</div>
<div class="col-first odd-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr>&lt;<a href="../models/LlmResponse.html" title="class in com.google.adk.models">LlmResponse</a>&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="Plugin.html#beforeModelCallback(com.google.adk.agents.CallbackContext,com.google.adk.models.LlmRequest.Builder)" class="member-name-link">beforeModelCallback</a><wbr>(<a href="../agents/CallbackContext.html" title="class in com.google.adk.agents">CallbackContext</a>&nbsp;callbackContext,
<a href="../models/LlmRequest.Builder.html" title="class in com.google.adk.models">LlmRequest.Builder</a>&nbsp;llmRequest)</code></div>
<div class="col-last odd-row-color">
<div class="block">Callback executed before a request is sent to the model.</div>
</div>
<div class="col-first even-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr>&lt;com.google.genai.types.Content&gt;</code></div>
<div class="col-second even-row-color"><code><a href="Plugin.html#beforeRunCallback(com.google.adk.agents.InvocationContext)" class="member-name-link">beforeRunCallback</a><wbr>(<a href="../agents/InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a>&nbsp;invocationContext)</code></div>
<div class="col-last even-row-color">
<div class="block">Callback executed before the ADK runner runs.</div>
</div>
<div class="col-first odd-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="Plugin.html#beforeToolCallback(com.google.adk.tools.BaseTool,java.util.Map,com.google.adk.tools.ToolContext)" class="member-name-link">beforeToolCallback</a><wbr>(<a href="../tools/BaseTool.html" title="class in com.google.adk.tools">BaseTool</a>&nbsp;tool,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;&nbsp;toolArgs,
<a href="../tools/ToolContext.html" title="class in com.google.adk.tools">ToolContext</a>&nbsp;toolContext)</code></div>
<div class="col-last odd-row-color">
<div class="block">Callback executed before a tool is called.</div>
</div>
<div class="col-first even-row-color"><code>default io.reactivex.rxjava3.core.Completable</code></div>
<div class="col-second even-row-color"><code><a href="Plugin.html#close()" class="member-name-link">close</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Method executed when the runner is closed.</div>
</div>
<div class="col-first odd-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr>&lt;<a href="../events/Event.html" title="class in com.google.adk.events">Event</a>&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="Plugin.html#onEventCallback(com.google.adk.agents.InvocationContext,com.google.adk.events.Event)" class="member-name-link">onEventCallback</a><wbr>(<a href="../agents/InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a>&nbsp;invocationContext,
<a href="../events/Event.html" title="class in com.google.adk.events">Event</a>&nbsp;event)</code></div>
<div class="col-last odd-row-color">
<div class="block">Callback executed after an event is yielded from runner.</div>
</div>
<div class="col-first even-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr>&lt;<a href="../models/LlmResponse.html" title="class in com.google.adk.models">LlmResponse</a>&gt;</code></div>
<div class="col-second even-row-color"><code><a href="Plugin.html#onModelErrorCallback(com.google.adk.agents.CallbackContext,com.google.adk.models.LlmRequest.Builder,java.lang.Throwable)" class="member-name-link">onModelErrorCallback</a><wbr>(<a href="../agents/CallbackContext.html" title="class in com.google.adk.agents">CallbackContext</a>&nbsp;callbackContext,
<a href="../models/LlmRequest.Builder.html" title="class in com.google.adk.models">LlmRequest.Builder</a>&nbsp;llmRequest,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class in java.lang" class="external-link">Throwable</a>&nbsp;error)</code></div>
<div class="col-last even-row-color">
<div class="block">Callback executed when a model call encounters an error.</div>
</div>
<div class="col-first odd-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="Plugin.html#onToolErrorCallback(com.google.adk.tools.BaseTool,java.util.Map,com.google.adk.tools.ToolContext,java.lang.Throwable)" class="member-name-link">onToolErrorCallback</a><wbr>(<a href="../tools/BaseTool.html" title="class in com.google.adk.tools">BaseTool</a>&nbsp;tool,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;&nbsp;toolArgs,
<a href="../tools/ToolContext.html" title="class in com.google.adk.tools">ToolContext</a>&nbsp;toolContext,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class in java.lang" class="external-link">Throwable</a>&nbsp;error)</code></div>
<div class="col-last odd-row-color">
<div class="block">Callback executed when a tool call encounters an error.</div>
</div>
<div class="col-first even-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr>&lt;com.google.genai.types.Content&gt;</code></div>
<div class="col-second even-row-color"><code><a href="Plugin.html#onUserMessageCallback(com.google.adk.agents.InvocationContext,com.google.genai.types.Content)" class="member-name-link">onUserMessageCallback</a><wbr>(<a href="../agents/InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a>&nbsp;invocationContext,
com.google.genai.types.Content&nbsp;userMessage)</code></div>
<div class="col-last even-row-color">
<div class="block">Callback executed when a user message is received before an invocation starts.</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="name">
<h3>name</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">name</span></div>
</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String)">
<h3>BasePlugin</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">BasePlugin</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Constructs a new plugin with the given name.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The name of the plugin.</dd>
</dl>
</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getName()">
<h3>getName</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getName</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Plugin.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="Plugin.html" title="interface in com.google.adk.plugins">Plugin</a></code></dd>
</dl>
</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
<footer>
<hr>
<p class="legal-copy"><small>Copyright &#169; 1980. All rights reserved.</small></p>
</footer>
</main>
</div>
</body>
</html>