google__adk-docs/api-reference/java/com/google/adk/agents/class-use/InvocationContext.Builder.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>Uses of Class com.google.adk.agents.InvocationContext.Builder (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="use: package: com.google.adk.agents, class: InvocationContext, class: Builder">
<meta name="generator" content="javadoc/ClassUseWriter">
<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-use-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><a href="../InvocationContext.Builder.html">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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.agents</a></li>
<li><a href="../InvocationContext.html">InvocationContext</a></li>
<li><a href="../InvocationContext.Builder.html" class="current-selection">Builder</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">
<main role="main">
<div class="header">
<h1 title="Uses of Class com.google.adk.agents.InvocationContext.Builder" class="title">Uses of Class<br>com.google.adk.agents.InvocationContext.Builder</h1>
</div>
<div class="caption"><span>Packages that use <a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#com.google.adk.agents">com.google.adk.agents</a></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="com.google.adk.agents">
<h2>Uses of <a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a> in <a href="../package-summary.html">com.google.adk.agents</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">com.google.adk.agents</a> that return <a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#agent(com.google.adk.agents.BaseAgent)" class="member-name-link">agent</a><wbr>(<a href="../BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a>&nbsp;agent)</code></div>
<div class="col-last even-row-color">
<div class="block">Sets the agent being invoked.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#artifactService(com.google.adk.artifacts.BaseArtifactService)" class="member-name-link">artifactService</a><wbr>(<a href="../../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a>&nbsp;artifactService)</code></div>
<div class="col-last odd-row-color">
<div class="block">Sets the artifact service for persisting artifacts.</div>
</div>
<div class="col-first even-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#branch(java.lang.String)" class="member-name-link">branch</a><wbr>(@Nullable <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;branch)</code></div>
<div class="col-last even-row-color">
<div class="block">Sets the branch ID for the invocation.</div>
</div>
<div class="col-first odd-row-color"><code>static <a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">InvocationContext.</span><code><a href="../InvocationContext.html#builder()" class="member-name-link">builder</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Returns a new <a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents"><code>InvocationContext.Builder</code></a> for creating <a href="../InvocationContext.html" title="class in com.google.adk.agents"><code>InvocationContext</code></a> instances.</div>
</div>
<div class="col-first even-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#callbackContextData(java.util.Map)" class="member-name-link">callbackContextData</a><wbr>(<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;callbackContextData)</code></div>
<div class="col-last even-row-color">
<div class="block">Sets the callback context data for the invocation.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#contextCacheConfig(com.google.adk.agents.ContextCacheConfig)" class="member-name-link">contextCacheConfig</a><wbr>(@Nullable <a href="../ContextCacheConfig.html" title="class in com.google.adk.agents">ContextCacheConfig</a>&nbsp;contextCacheConfig)</code></div>
<div class="col-last odd-row-color">
<div class="block">Sets the context cache configuration for the current agent run.</div>
</div>
<div class="col-first even-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#endInvocation(boolean)" class="member-name-link">endInvocation</a><wbr>(boolean&nbsp;endInvocation)</code></div>
<div class="col-last even-row-color">
<div class="block">Sets whether this invocation should be ended.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#eventsCompactionConfig(com.google.adk.summarizer.EventsCompactionConfig)" class="member-name-link">eventsCompactionConfig</a><wbr>(@Nullable <a href="../../summarizer/EventsCompactionConfig.html" title="class in com.google.adk.summarizer">EventsCompactionConfig</a>&nbsp;eventsCompactionConfig)</code></div>
<div class="col-last odd-row-color">
<div class="block">Sets the events compaction configuration for the current agent run.</div>
</div>
<div class="col-first even-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#invocationId(java.lang.String)" class="member-name-link">invocationId</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;invocationId)</code></div>
<div class="col-last even-row-color">
<div class="block">Sets the unique ID for the invocation.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#liveRequestQueue(com.google.adk.agents.LiveRequestQueue)" class="member-name-link">liveRequestQueue</a><wbr>(@Nullable <a href="../LiveRequestQueue.html" title="class in com.google.adk.agents">LiveRequestQueue</a>&nbsp;liveRequestQueue)</code></div>
<div class="col-last odd-row-color">
<div class="block">Sets the queue for managing live requests.</div>
</div>
<div class="col-first even-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#memoryService(com.google.adk.memory.BaseMemoryService)" class="member-name-link">memoryService</a><wbr>(<a href="../../memory/BaseMemoryService.html" title="interface in com.google.adk.memory">BaseMemoryService</a>&nbsp;memoryService)</code></div>
<div class="col-last even-row-color">
<div class="block">Sets the memory service for accessing agent memory.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#pluginManager(com.google.adk.plugins.Plugin)" class="member-name-link">pluginManager</a><wbr>(<a href="../../plugins/Plugin.html" title="interface in com.google.adk.plugins">Plugin</a>&nbsp;pluginManager)</code></div>
<div class="col-last odd-row-color">
<div class="block">Sets the plugin manager for accessing tools and plugins.</div>
</div>
<div class="col-first even-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#resumabilityConfig(com.google.adk.apps.ResumabilityConfig)" class="member-name-link">resumabilityConfig</a><wbr>(@Nullable <a href="../../apps/ResumabilityConfig.html" title="class in com.google.adk.apps">ResumabilityConfig</a>&nbsp;resumabilityConfig)</code></div>
<div class="col-last even-row-color">
<div class="block">Sets the resumability configuration for the invocation.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#runConfig(com.google.adk.agents.RunConfig)" class="member-name-link">runConfig</a><wbr>(<a href="../RunConfig.html" title="class in com.google.adk.agents">RunConfig</a>&nbsp;runConfig)</code></div>
<div class="col-last odd-row-color">
<div class="block">Sets the configuration for the current agent run.</div>
</div>
<div class="col-first even-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#session(com.google.adk.sessions.Session)" class="member-name-link">session</a><wbr>(<a href="../../sessions/Session.html" title="class in com.google.adk.sessions">Session</a>&nbsp;session)</code></div>
<div class="col-last even-row-color">
<div class="block">Sets the session associated with this invocation.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#sessionService(com.google.adk.sessions.BaseSessionService)" class="member-name-link">sessionService</a><wbr>(<a href="../../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a>&nbsp;sessionService)</code></div>
<div class="col-last odd-row-color">
<div class="block">Sets the session service for managing session state.</div>
</div>
<div class="col-first even-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">InvocationContext.</span><code><a href="../InvocationContext.html#toBuilder()" class="member-name-link">toBuilder</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Returns a <a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents"><code>InvocationContext.Builder</code></a> initialized with the values of this instance.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">InvocationContext.Builder.</span><code><a href="../InvocationContext.Builder.html#userContent(com.google.genai.types.Content)" class="member-name-link">userContent</a><wbr>(@Nullable com.google.genai.types.Content&nbsp;userContent)</code></div>
<div class="col-last odd-row-color">
<div class="block">Sets the user content that triggered this invocation.</div>
</div>
</div>
<div class="caption"><span>Constructors in <a href="../package-summary.html">com.google.adk.agents</a> with parameters of type <a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-second even-row-color"><code><a href="../InvocationContext.html#%3Cinit%3E(com.google.adk.agents.InvocationContext.Builder)" class="member-name-link">InvocationContext</a><wbr>(<a href="../InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a>&nbsp;builder)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
</ul>
</section>
<footer>
<hr>
<p class="legal-copy"><small>Copyright &#169; 1980. All rights reserved.</small></p>
</footer>
</main>
</div>
</body>
</html>