mirror of
https://github.com/google/adk-docs.git
synced 2026-09-14 16:16:59 +08:00
453 lines
43 KiB
HTML
453 lines
43 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>GcsArtifactService (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.artifacts, class: GcsArtifactService">
|
|
<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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </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/GcsArtifactService.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.artifacts</a></li>
|
|
<li><a href="GcsArtifactService.html" class="current-selection">GcsArtifactService</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 <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"> <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="#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(java.lang.String,com.google.cloud.storage.Storage)" tabindex="0">GcsArtifactService(String, Storage)</a></li>
|
|
</ol>
|
|
</li>
|
|
<li><a href="#method-detail" tabindex="0">Method Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#saveArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.google.genai.types.Part)" tabindex="0">saveArtifact(String, String, String, String, Part)</a></li>
|
|
<li><a href="#loadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer)" tabindex="0">loadArtifact(String, String, String, String, Integer)</a></li>
|
|
<li><a href="#listArtifactKeys(java.lang.String,java.lang.String,java.lang.String)" tabindex="0">listArtifactKeys(String, String, String)</a></li>
|
|
<li><a href="#deleteArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String)" tabindex="0">deleteArtifact(String, String, String, String)</a></li>
|
|
<li><a href="#listVersions(java.lang.String,java.lang.String,java.lang.String,java.lang.String)" tabindex="0">listVersions(String, String, String, String)</a></li>
|
|
<li><a href="#saveAndReloadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.google.genai.types.Part)" tabindex="0">saveAndReloadArtifact(String, String, String, String, Part)</a></li>
|
|
</ol>
|
|
</li>
|
|
</ol>
|
|
<button class="hide-sidebar"><span>Hide sidebar </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> Show sidebar</span></button></nav>
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<h1 title="Class GcsArtifactService" class="title">Class GcsArtifactService</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.artifacts.GcsArtifactService</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="horizontal-scroll">
|
|
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">GcsArtifactService</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="BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a></span></div>
|
|
<div class="block">An artifact service implementation using Google Cloud Storage (GCS).</div>
|
|
</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== 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,com.google.cloud.storage.Storage)" class="member-name-link">GcsArtifactService</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> bucketName,
|
|
com.google.cloud.storage.Storage storageClient)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Initializes the GcsArtifactService.</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>io.reactivex.rxjava3.core.Completable</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">deleteArtifact</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> appName,
|
|
<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> userId,
|
|
<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> sessionId,
|
|
<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> filename)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Deletes all versions of the specified artifact from GCS.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>io.reactivex.rxjava3.core.Single<wbr><<a href="ListArtifactsResponse.html" title="class in com.google.adk.artifacts">ListArtifactsResponse</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listArtifactKeys(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">listArtifactKeys</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> appName,
|
|
<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> userId,
|
|
<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> sessionId)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Lists artifact filenames for a user and session.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>io.reactivex.rxjava3.core.Single<wbr><com.google.common.collect.ImmutableList<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a>>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listVersions(java.lang.String,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">listVersions</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> appName,
|
|
<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> userId,
|
|
<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> sessionId,
|
|
<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> filename)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Lists all available versions for a given artifact.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>io.reactivex.rxjava3.core.Maybe<wbr><com.google.genai.types.Part></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#loadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer)" class="member-name-link">loadArtifact</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> appName,
|
|
<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> userId,
|
|
<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> sessionId,
|
|
<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> filename,
|
|
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a> version)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Loads an artifact from GCS.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>io.reactivex.rxjava3.core.Single<wbr><com.google.genai.types.Part></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#saveAndReloadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.google.genai.types.Part)" class="member-name-link">saveAndReloadArtifact</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> appName,
|
|
<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> userId,
|
|
<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> sessionId,
|
|
<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> filename,
|
|
com.google.genai.types.Part artifact)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Saves an artifact and returns it with fileData if available.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>io.reactivex.rxjava3.core.Single<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#saveArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.google.genai.types.Part)" class="member-name-link">saveArtifact</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> appName,
|
|
<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> userId,
|
|
<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> sessionId,
|
|
<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> filename,
|
|
com.google.genai.types.Part artifact)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Saves an artifact to GCS and assigns a new version.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class <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.artifacts.BaseArtifactService">Methods inherited from interface <a href="BaseArtifactService.html#method-summary" title="interface in com.google.adk.artifacts">BaseArtifactService</a></h3>
|
|
<code><a href="BaseArtifactService.html#deleteArtifact(com.google.adk.sessions.SessionKey,java.lang.String)" title="deleteArtifact(SessionKey, String)">deleteArtifact</a>, <a href="BaseArtifactService.html#listArtifactKeys(com.google.adk.sessions.SessionKey)" title="listArtifactKeys(SessionKey)">listArtifactKeys</a>, <a href="BaseArtifactService.html#listVersions(com.google.adk.sessions.SessionKey,java.lang.String)" title="listVersions(SessionKey, String)">listVersions</a>, <a href="BaseArtifactService.html#loadArtifact(com.google.adk.sessions.SessionKey,java.lang.String)" title="loadArtifact(SessionKey, String)">loadArtifact</a>, <a href="BaseArtifactService.html#loadArtifact(com.google.adk.sessions.SessionKey,java.lang.String,int)" title="loadArtifact(SessionKey, String, int)">loadArtifact</a>, <a href="BaseArtifactService.html#loadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String)" title="loadArtifact(String, String, String, String)">loadArtifact</a>, <a href="BaseArtifactService.html#loadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,int)" title="loadArtifact(String, String, String, String, int)">loadArtifact</a>, <a href="BaseArtifactService.html#saveAndReloadArtifact(com.google.adk.sessions.SessionKey,java.lang.String,com.google.genai.types.Part)" title="saveAndReloadArtifact(SessionKey, String, Part)">saveAndReloadArtifact</a>, <a href="BaseArtifactService.html#saveArtifact(com.google.adk.sessions.SessionKey,java.lang.String,com.google.genai.types.Part)" title="saveArtifact(SessionKey, String, Part)">saveArtifact</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.Completable</code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseArtifactService.html#deleteArtifact(com.google.adk.sessions.SessionKey,java.lang.String)" class="member-name-link">deleteArtifact</a><wbr>(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
<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> filename)</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-first odd-row-color"><code>default io.reactivex.rxjava3.core.Single<wbr><<a href="ListArtifactsResponse.html" title="class in com.google.adk.artifacts">ListArtifactsResponse</a>></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseArtifactService.html#listArtifactKeys(com.google.adk.sessions.SessionKey)" class="member-name-link">listArtifactKeys</a><wbr>(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey)</code></div>
|
|
<div class="col-last odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>default io.reactivex.rxjava3.core.Single<wbr><com.google.common.collect.ImmutableList<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a>>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseArtifactService.html#listVersions(com.google.adk.sessions.SessionKey,java.lang.String)" class="member-name-link">listVersions</a><wbr>(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
<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> filename)</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-first odd-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr><com.google.genai.types.Part></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseArtifactService.html#loadArtifact(com.google.adk.sessions.SessionKey,java.lang.String)" class="member-name-link">loadArtifact</a><wbr>(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
<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> filename)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Loads the latest version of an artifact from the service.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr><com.google.genai.types.Part></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseArtifactService.html#loadArtifact(com.google.adk.sessions.SessionKey,java.lang.String,int)" class="member-name-link">loadArtifact</a><wbr>(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
<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> filename,
|
|
int version)</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-first odd-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr><com.google.genai.types.Part></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseArtifactService.html#loadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">loadArtifact</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> appName,
|
|
<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> userId,
|
|
<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> sessionId,
|
|
<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> filename)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Loads the latest version of an artifact from the service.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>default io.reactivex.rxjava3.core.Maybe<wbr><com.google.genai.types.Part></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseArtifactService.html#loadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,int)" class="member-name-link">loadArtifact</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> appName,
|
|
<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> userId,
|
|
<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> sessionId,
|
|
<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> filename,
|
|
int version)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Loads a specific version of an artifact from the service.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>default io.reactivex.rxjava3.core.Single<wbr><com.google.genai.types.Part></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseArtifactService.html#saveAndReloadArtifact(com.google.adk.sessions.SessionKey,java.lang.String,com.google.genai.types.Part)" class="member-name-link">saveAndReloadArtifact</a><wbr>(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
<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> filename,
|
|
com.google.genai.types.Part artifact)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Saves an artifact and returns it with fileData if available.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>default io.reactivex.rxjava3.core.Single<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseArtifactService.html#saveArtifact(com.google.adk.sessions.SessionKey,java.lang.String,com.google.genai.types.Part)" class="member-name-link">saveArtifact</a><wbr>(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
<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> filename,
|
|
com.google.genai.types.Part artifact)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Saves an artifact.</div>
|
|
</div>
|
|
</div>
|
|
</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="<init>(java.lang.String,com.google.cloud.storage.Storage)">
|
|
<h3>GcsArtifactService</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">GcsArtifactService</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> bucketName,
|
|
com.google.cloud.storage.Storage storageClient)</span></div>
|
|
<div class="block">Initializes the GcsArtifactService.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>bucketName</code> - The name of the GCS bucket to use.</dd>
|
|
<dd><code>storageClient</code> - The GCS storage client instance.</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="saveArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.google.genai.types.Part)">
|
|
<h3>saveArtifact</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">io.reactivex.rxjava3.core.Single<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a>></span> <span class="element-name">saveArtifact</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> appName,
|
|
<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> userId,
|
|
<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> sessionId,
|
|
<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> filename,
|
|
com.google.genai.types.Part artifact)</span></div>
|
|
<div class="block">Saves an artifact to GCS and assigns a new version.</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="BaseArtifactService.html#saveArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.google.genai.types.Part)">saveArtifact</a></code> in interface <code><a href="BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - Application name.</dd>
|
|
<dd><code>userId</code> - User ID.</dd>
|
|
<dd><code>sessionId</code> - Session ID.</dd>
|
|
<dd><code>filename</code> - Artifact filename.</dd>
|
|
<dd><code>artifact</code> - Artifact content to save.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Single with assigned version number.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="loadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer)">
|
|
<h3>loadArtifact</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">io.reactivex.rxjava3.core.Maybe<com.google.genai.types.Part></span> <span class="element-name">loadArtifact</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> appName,
|
|
<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> userId,
|
|
<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> sessionId,
|
|
<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> filename,
|
|
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a> version)</span></div>
|
|
<div class="block">Loads an artifact from GCS.</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="BaseArtifactService.html#loadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer)">loadArtifact</a></code> in interface <code><a href="BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - Application name.</dd>
|
|
<dd><code>userId</code> - User ID.</dd>
|
|
<dd><code>sessionId</code> - Session ID.</dd>
|
|
<dd><code>filename</code> - Artifact filename.</dd>
|
|
<dd><code>version</code> - Optional version to load. Loads latest if empty.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Maybe with loaded artifact, or empty if not found.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="listArtifactKeys(java.lang.String,java.lang.String,java.lang.String)">
|
|
<h3>listArtifactKeys</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">io.reactivex.rxjava3.core.Single<<a href="ListArtifactsResponse.html" title="class in com.google.adk.artifacts">ListArtifactsResponse</a>></span> <span class="element-name">listArtifactKeys</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> appName,
|
|
<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> userId,
|
|
<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> sessionId)</span></div>
|
|
<div class="block">Lists artifact filenames for a user and session.</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="BaseArtifactService.html#listArtifactKeys(java.lang.String,java.lang.String,java.lang.String)">listArtifactKeys</a></code> in interface <code><a href="BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - Application name.</dd>
|
|
<dd><code>userId</code> - User ID.</dd>
|
|
<dd><code>sessionId</code> - Session ID.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Single with sorted list of artifact filenames.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="deleteArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">
|
|
<h3>deleteArtifact</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">io.reactivex.rxjava3.core.Completable</span> <span class="element-name">deleteArtifact</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> appName,
|
|
<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> userId,
|
|
<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> sessionId,
|
|
<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> filename)</span></div>
|
|
<div class="block">Deletes all versions of the specified artifact from GCS.</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="BaseArtifactService.html#deleteArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">deleteArtifact</a></code> in interface <code><a href="BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - Application name.</dd>
|
|
<dd><code>userId</code> - User ID.</dd>
|
|
<dd><code>sessionId</code> - Session ID.</dd>
|
|
<dd><code>filename</code> - Artifact filename.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Completable indicating operation completion.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="listVersions(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">
|
|
<h3>listVersions</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">io.reactivex.rxjava3.core.Single<com.google.common.collect.ImmutableList<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a>>></span> <span class="element-name">listVersions</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> appName,
|
|
<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> userId,
|
|
<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> sessionId,
|
|
<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> filename)</span></div>
|
|
<div class="block">Lists all available versions for a given artifact.</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="BaseArtifactService.html#listVersions(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">listVersions</a></code> in interface <code><a href="BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - Application name.</dd>
|
|
<dd><code>userId</code> - User ID.</dd>
|
|
<dd><code>sessionId</code> - Session ID.</dd>
|
|
<dd><code>filename</code> - Artifact filename.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Single with sorted list of version numbers.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="saveAndReloadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.google.genai.types.Part)">
|
|
<h3>saveAndReloadArtifact</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">io.reactivex.rxjava3.core.Single<com.google.genai.types.Part></span> <span class="element-name">saveAndReloadArtifact</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> appName,
|
|
<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> userId,
|
|
<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> sessionId,
|
|
<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> filename,
|
|
com.google.genai.types.Part artifact)</span></div>
|
|
<div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="BaseArtifactService.html#saveAndReloadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.google.genai.types.Part)">BaseArtifactService</a></code></span></div>
|
|
<div class="block">Saves an artifact and returns it with fileData if available.
|
|
|
|
<p>Implementations should override this default method for efficiency, as the default performs
|
|
two I/O operations (save then load).</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="BaseArtifactService.html#saveAndReloadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.google.genai.types.Part)">saveAndReloadArtifact</a></code> in interface <code><a href="BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - the app name</dd>
|
|
<dd><code>userId</code> - the user ID</dd>
|
|
<dd><code>sessionId</code> - the session ID</dd>
|
|
<dd><code>filename</code> - the filename</dd>
|
|
<dd><code>artifact</code> - the artifact to save</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the saved artifact with fileData if available.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer>
|
|
<hr>
|
|
<p class="legal-copy"><small>Copyright © 1980. All rights reserved.</small></p>
|
|
</footer>
|
|
</main>
|
|
</div>
|
|
</body>
|
|
</html>
|