Files
2026-03-13 18:30:55 +00:00

306 lines
22 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 (25) -->
<title>RemoteA2AAgent (Google Agent Development Kit Maven Parent POM 0.9.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.a2a, class: RemoteA2AAgent">
<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(document, 'script');</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/RemoteA2AAgent.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>
</ul>
</div>
</div>
<div class="sub-nav">
<div class="nav-content">
<ol class="sub-nav-list">
<li><a href="package-summary.html">com.google.adk.a2a</a></li>
<li><a href="RemoteA2AAgent.html" class="current-selection">RemoteA2AAgent</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"></div>
<ol class="toc-list" tabindex="-1">
<li><a href="#" tabindex="0">Description</a></li>
<li><a href="#nested-class-summary" tabindex="0">Nested Class Summary</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="#constructor-detail" tabindex="0">Constructor Details</a>
<ol class="toc-list">
<li><a href="#%3Cinit%3E()" tabindex="0">RemoteA2AAgent()</a></li>
</ol>
</li>
<li><a href="#method-detail" tabindex="0">Method Details</a>
<ol class="toc-list">
<li><a href="#builder()" tabindex="0">builder()</a></li>
<li><a href="#rpcUrl()" tabindex="0">rpcUrl()</a></li>
<li><a href="#runAsyncImpl(com.google.adk.agents.InvocationContext)" tabindex="0">runAsyncImpl(InvocationContext)</a></li>
<li><a href="#runLiveImpl(com.google.adk.agents.InvocationContext)" tabindex="0">runLiveImpl(InvocationContext)</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 RemoteA2AAgent" class="title">Class RemoteA2AAgent</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 or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">com.google.adk.agents.BaseAgent</a>
<div class="inheritance">com.google.adk.a2a.RemoteA2AAgent</div>
</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="horizontal-scroll">
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RemoteA2AAgent</span>
<span class="extends-implements">extends <a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a></span></div>
<div class="block">Agent that communicates with a remote A2A agent via A2A client.
<p>This agent supports multiple ways to specify the remote agent:
<ol>
<li>Direct AgentCard object
<li>URL to agent card JSON
<li>File path to agent card JSON
</ol>
<p>The agent handles:
<ul>
<li>Agent card resolution and validation
<li>A2A message conversion and error handling
<li>Session state management across requests
</ul>
<p>**EXPERIMENTAL:** Subject to change, rename, or removal in any future patch release. Do not
use in production code.</div>
</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</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">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="RemoteA2AAgent.A2AClientError.html" class="type-name-link" title="class in com.google.adk.a2a">RemoteA2AAgent.A2AClientError</a></code></div>
<div class="col-last even-row-color">
<div class="block">Exception thrown when the A2A client encounters an error.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="RemoteA2AAgent.AgentCardResolutionError.html" class="type-name-link" title="class in com.google.adk.a2a">RemoteA2AAgent.AgentCardResolutionError</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Exception thrown when the agent card cannot be resolved.</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="RemoteA2AAgent.Builder.html" class="type-name-link" title="class in com.google.adk.a2a">RemoteA2AAgent.Builder</a></code></div>
<div class="col-last even-row-color">
<div class="block">Builder for <a href="RemoteA2AAgent.html" title="class in com.google.adk.a2a"><code>RemoteA2AAgent</code></a>.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="RemoteA2AAgent.TypeError.html" class="type-name-link" title="class in com.google.adk.a2a">RemoteA2AAgent.TypeError</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Exception thrown when a type error occurs.</div>
</div>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-com.google.adk.agents.BaseAgent">Fields inherited from class&nbsp;<a href="../agents/BaseAgent.html#field-summary" title="class in com.google.adk.agents">BaseAgent</a></h3>
<code><a href="../agents/BaseAgent.html#callbackPlugin">callbackPlugin</a></code></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()" class="member-name-link">RemoteA2AAgent</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab1 method-summary-table-tab4"><code>static <a href="RemoteA2AAgent.Builder.html" title="class in com.google.adk.a2a">RemoteA2AAgent.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder()" class="member-name-link">builder</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-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/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#rpcUrl()" class="member-name-link">rpcUrl</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected io.reactivex.rxjava3.core.Flowable<wbr>&lt;<a href="../events/Event.html" title="class in com.google.adk.events">Event</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runAsyncImpl(com.google.adk.agents.InvocationContext)" class="member-name-link">runAsyncImpl</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 method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Agent-specific asynchronous logic.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected io.reactivex.rxjava3.core.Flowable<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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runLiveImpl(com.google.adk.agents.InvocationContext)" class="member-name-link">runLiveImpl</a><wbr>(<a href="../agents/InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a>&nbsp;invocationContext)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Agent-specific synchronous logic.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-com.google.adk.agents.BaseAgent">Methods inherited from class&nbsp;<a href="../agents/BaseAgent.html#method-summary" title="class in com.google.adk.agents">BaseAgent</a></h3>
<code><a href="../agents/BaseAgent.html#afterAgentCallback()" title="afterAgentCallback()">afterAgentCallback</a>, <a href="../agents/BaseAgent.html#beforeAgentCallback()" title="beforeAgentCallback()">beforeAgentCallback</a>, <a href="../agents/BaseAgent.html#description()" title="description()">description</a>, <a href="../agents/BaseAgent.html#findAgent(java.lang.String)" title="findAgent(String)">findAgent</a>, <a href="../agents/BaseAgent.html#findSubAgent(java.lang.String)" title="findSubAgent(String)">findSubAgent</a>, <a href="../agents/BaseAgent.html#fromConfig(com.google.adk.agents.BaseAgentConfig,java.lang.String)" title="fromConfig(BaseAgentConfig, String)">fromConfig</a>, <a href="../agents/BaseAgent.html#getPlugin()" title="getPlugin()">getPlugin</a>, <a href="../agents/BaseAgent.html#name()" title="name()">name</a>, <a href="../agents/BaseAgent.html#parentAgent()" title="parentAgent()">parentAgent</a>, <a href="../agents/BaseAgent.html#parentAgent(com.google.adk.agents.BaseAgent)" title="parentAgent(BaseAgent)">parentAgent</a>, <a href="../agents/BaseAgent.html#rootAgent()" title="rootAgent()">rootAgent</a>, <a href="../agents/BaseAgent.html#runAsync(com.google.adk.agents.InvocationContext)" title="runAsync(InvocationContext)">runAsync</a>, <a href="../agents/BaseAgent.html#runLive(com.google.adk.agents.InvocationContext)" title="runLive(InvocationContext)">runLive</a>, <a href="../agents/BaseAgent.html#subAgents()" title="subAgents()">subAgents</a></code></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 or interface 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= 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;()">
<h3>RemoteA2AAgent</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RemoteA2AAgent</span>()</div>
</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="builder()">
<h3>builder</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="RemoteA2AAgent.Builder.html" title="class in com.google.adk.a2a">RemoteA2AAgent.Builder</a></span>&nbsp;<span class="element-name">builder</span>()</div>
</div>
</section>
</li>
<li>
<section class="detail" id="rpcUrl()">
<h3>rpcUrl</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/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">rpcUrl</span>()</div>
</div>
</section>
</li>
<li>
<section class="detail" id="runAsyncImpl(com.google.adk.agents.InvocationContext)">
<h3>runAsyncImpl</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">io.reactivex.rxjava3.core.Flowable&lt;<a href="../events/Event.html" title="class in com.google.adk.events">Event</a>&gt;</span>&nbsp;<span class="element-name">runAsyncImpl</span><wbr><span class="parameters">(<a href="../agents/InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a>&nbsp;invocationContext)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from class:&nbsp;<code><a href="../agents/BaseAgent.html#runAsyncImpl(com.google.adk.agents.InvocationContext)">BaseAgent</a></code></span></div>
<div class="block">Agent-specific asynchronous logic.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../agents/BaseAgent.html#runAsyncImpl(com.google.adk.agents.InvocationContext)">runAsyncImpl</a></code>&nbsp;in class&nbsp;<code><a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a></code></dd>
<dt>Parameters:</dt>
<dd><code>invocationContext</code> - Current invocation context.</dd>
<dt>Returns:</dt>
<dd>stream of agent-generated events.</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="runLiveImpl(com.google.adk.agents.InvocationContext)">
<h3>runLiveImpl</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">io.reactivex.rxjava3.core.Flowable&lt;<a href="../events/Event.html" title="class in com.google.adk.events">Event</a>&gt;</span>&nbsp;<span class="element-name">runLiveImpl</span><wbr><span class="parameters">(<a href="../agents/InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a>&nbsp;invocationContext)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from class:&nbsp;<code><a href="../agents/BaseAgent.html#runLiveImpl(com.google.adk.agents.InvocationContext)">BaseAgent</a></code></span></div>
<div class="block">Agent-specific synchronous logic.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../agents/BaseAgent.html#runLiveImpl(com.google.adk.agents.InvocationContext)">runLiveImpl</a></code>&nbsp;in class&nbsp;<code><a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a></code></dd>
<dt>Parameters:</dt>
<dd><code>invocationContext</code> - Current invocation context.</dd>
<dt>Returns:</dt>
<dd>stream of agent-generated events.</dd>
</dl>
</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 1980. All rights reserved.</small></p>
</footer>
</main>
</div>
</body>
</html>