Google Git
Sign in
apache / pulsar-site / aee2d9089b6b8e327f04261353077211f4abd636 / . / content / docs / en / 2.7.4 / admin-api-functions.html
blob: da56e162c575698d7bd3f69c3bc7c2b32f53cbdf [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Manage Functions · Apache Pulsar</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="**Pulsar Functions** are lightweight compute processes that"/><meta name="docsearch:version" content="2.7.4"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Manage Functions · Apache Pulsar"/><meta property="og:type" content="website"/><meta property="og:url" content="https://pulsar.apache.org/"/><meta property="og:description" content="**Pulsar Functions** are lightweight compute processes that"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://pulsar.apache.org/img/pulsar.svg"/><link rel="shortcut icon" href="/img/pulsar.ico"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://pulsar.apache.org/blog/atom.xml" title="Apache Pulsar Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://pulsar.apache.org/blog/feed.xml" title="Apache Pulsar Blog RSS Feed"/><link rel="stylesheet" href="/css/code-blocks-buttons.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/custom.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/en"><img class="logo" src="/img/pulsar.svg" alt="Apache Pulsar"/></a><a href="/en/versions"><h3>2.7.4</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/en/2.7.4/getting-started-standalone" target="_self">Docs</a></li><li class=""><a href="/en/download" target="_self">Download</a></li><li class="siteNavGroupActive"><a href="/docs/en/2.7.4/client-libraries" target="_self">Clients</a></li><li class=""><a href="#restapis" target="_self">REST APIs</a></li><li class=""><a href="#cli" target="_self">Cli</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li><li class=""><a href="#community" target="_self">Community</a></li><li class=""><a href="#apache" target="_self">Apache</a></li><li class=""><a href="https://pulsar-next.staged.apache.org/" target="_self">New Website (Beta)</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg" alt="Languages icon"/>English</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/ja/2.7.4/admin-api-functions">日本語</a></li><li><a href="/docs/fr/2.7.4/admin-api-functions">Français</a></li><li><a href="/docs/ko/2.7.4/admin-api-functions">한국어</a></li><li><a href="/docs/zh-CN/2.7.4/admin-api-functions">中文</a></li><li><a href="/docs/zh-TW/2.7.4/admin-api-functions">繁體中文</a></li><li><a href="https://crowdin.com/project/apache-pulsar" target="_blank" rel="noreferrer noopener">Help Translate</a></li></ul></div></li><script>
const languagesMenuItem = document.getElementById("languages-menu");
const languagesDropDown = document.getElementById("languages-dropdown");
languagesMenuItem.addEventListener("click", function(event) {
event.preventDefault();
if (languagesDropDown.className == "hide") {
languagesDropDown.className = "visible";
} else {
languagesDropDown.className = "hide";
}
});
</script></span></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>Admin API</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Get Started</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/getting-started-standalone">Run Pulsar locally</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/getting-started-docker">Run Pulsar in Docker</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/getting-started-helm">Run Pulsar in Kubernetes</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Concepts and Architecture</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/concepts-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/concepts-messaging">Messaging</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/concepts-architecture-overview">Architecture</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/concepts-clients">Clients</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/concepts-replication">Geo Replication</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/concepts-multi-tenancy">Multi Tenancy</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/concepts-authentication">Authentication and Authorization</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/concepts-topic-compaction">Topic Compaction</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/concepts-proxy-sni-routing">Proxy support with SNI routing</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/concepts-multiple-advertised-listeners">Multiple advertised listeners</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar Schema</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/schema-get-started">Get started</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/schema-understand">Understand schema</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/schema-evolution-compatibility">Schema evolution and compatibility</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/schema-manage">Manage schema</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar Functions</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/functions-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/functions-worker">Setup: Pulsar Functions Worker</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/functions-runtime">Setup: Configure Functions runtime</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/functions-develop">How-to: Develop</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/functions-package">How-to: Package</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/functions-debug">How-to: Debug</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/functions-deploy">How-to: Deploy</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/functions-cli">Reference: CLI</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/window-functions-context">Window Functions: Context</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar IO</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/io-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/io-quickstart">Get started</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/io-use">Use</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/io-debug">Debug</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/io-connectors">Built-in connector</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/io-cdc">CDC connector</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/io-develop">Develop</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/io-cli">CLI</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar SQL</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/sql-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/sql-getting-started">Query data</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/sql-deployment-configurations">Configuration and deployment</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/sql-rest-api">REST APIs</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Tiered Storage</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/tiered-storage-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/tiered-storage-aws">AWS S3 offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/tiered-storage-gcs">GCS offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/tiered-storage-filesystem">Filesystem offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/tiered-storage-azure">Azure BlobStore offloader</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Transactions</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/transactions">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/transactions-guarantee">Transactions Guarantee</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/transactions-api">Transactions API</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Kubernetes (Helm)</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/helm-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/helm-prepare">Prepare</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/helm-install">Install</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/helm-deploy">Deployment</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/helm-upgrade">Upgrade</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/helm-tools">Required Tools</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Deployment</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/deploy-aws">Amazon Web Services</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/deploy-kubernetes">Kubernetes</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/deploy-bare-metal">Bare metal</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/deploy-bare-metal-multi-cluster">Bare metal multi-cluster</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/deploy-docker">Docker</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/deploy-monitoring">Monitor</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Administration</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/administration-zk-bk">ZooKeeper and BookKeeper</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/administration-geo">Geo-replication</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/administration-pulsar-manager">Pulsar Manager</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/administration-stats">Pulsar statistics</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/administration-load-balance">Load balance</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/administration-proxy">Pulsar proxy</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/administration-upgrade">Upgrade</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/administration-isolation">Pulsar isolation</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Security</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/security-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/security-tls-transport">Transport Encryption using TLS</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/security-tls-authentication">Authentication using TLS</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/security-tls-keystore">Using TLS with KeyStore configure</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/security-jwt">Authentication using JWT</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/security-athenz">Authentication using Athenz</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/security-kerberos">Authentication using Kerberos</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/security-oauth2">Authentication using OAuth 2.0 access tokens</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/security-authorization">Authorization and ACLs</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/security-encryption">End-to-End Encryption</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/security-extending">Extending</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/security-bouncy-castle">Bouncy Castle Providers</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Performance</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/performance-pulsar-perf">Pulsar Perf</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Client Libraries</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/client-libraries">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/client-libraries-java">Java</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/client-libraries-go">Go</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/client-libraries-python">Python</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/client-libraries-cpp">C++</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/client-libraries-node">Node.js</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/client-libraries-websocket">WebSocket</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/client-libraries-dotnet">C#</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Admin API</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/admin-api-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/admin-api-clusters">Clusters</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/admin-api-tenants">Tenants</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/admin-api-brokers">Brokers</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/admin-api-namespaces">Namespaces</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/admin-api-permissions">Permissions</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/admin-api-topics">Topics</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/en/2.7.4/admin-api-functions">Functions</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Adaptors</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/adaptors-kafka">Kafka client wrapper</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/adaptors-spark">Apache Spark</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/adaptors-storm">Apache Storm</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Cookbooks</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/cookbooks-compaction">Topic compaction</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/cookbooks-deduplication">Message deduplication</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/cookbooks-non-persistent">Non-persistent messaging</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/cookbooks-retention-expiry">Message retention and expiry</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/cookbooks-encryption">Encryption</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/cookbooks-message-queue">Message queue</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/cookbooks-bookkeepermetadata">BookKeeper Ledger Metadata</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Development</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/develop-tools">Simulation tools</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/developing-binary-protocol">Binary protocol</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/develop-schema">Custom schema storage</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/develop-load-manager">Modular load manager</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/develop-cpp">Building Pulsar C++ client</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Reference</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/reference-terminology">Terminology</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/reference-cli-tools">Pulsar CLI tools</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/reference-configuration">Pulsar configuration</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.7.4/reference-metrics">Pulsar Metrics</a></li></ul></div></div></section></div><script>
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
var links = coll[i].nextElementSibling.getElementsByTagName('*');
if (checkActiveCategory){
for (var j = 0; j < links.length; j++) {
if (links[j].classList.contains('navListItemActive')){
coll[i].nextElementSibling.classList.toggle('hide');
coll[i].childNodes[1].classList.toggle('rotate');
checkActiveCategory = false;
break;
}
}
}
coll[i].addEventListener('click', function() {
var arrow = this.childNodes[1];
arrow.classList.toggle('rotate');
var content = this.nextElementSibling;
content.classList.toggle('hide');
});
}
document.addEventListener('DOMContentLoaded', function() {
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
createToggler('#tocToggler', 'body', 'tocActive');
var headings = document.querySelector('.toc-headings');
headings && headings.addEventListener('click', function(event) {
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
}
}, false);
function createToggler(togglerSelector, targetSelector, className) {
var toggler = document.querySelector(togglerSelector);
var target = document.querySelector(targetSelector);
if (!toggler) {
return;
}
toggler.onclick = function(event) {
event.preventDefault();
target.classList.toggle(className);
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/apache/pulsar/edit/master/site2/docs/admin-api-functions.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Manage Functions</h1></header><article><div><span><p><strong>Pulsar Functions</strong> are lightweight compute processes that</p>
<ul>
<li>consume messages from one or more Pulsar topics</li>
<li>apply a user-supplied processing logic to each message</li>
<li>publish the results of the computation to another topic</li>
</ul>
<p>Functions can be managed via the following methods.</p>
<table>
<thead>
<tr><th>Method</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td><strong>Admin CLI</strong></td><td>The <a href="/docs/en/2.7.4/reference-pulsar-admin#functions"><code>functions</code></a> command of the <a href="/docs/en/2.7.4/reference-pulsar-admin"><code>pulsar-admin</code></a> tool.</td></tr>
<tr><td><strong>REST API</strong></td><td>The <code>/admin/v3/functions</code> endpoint of the admin <a href="https://pulsar.apache.org/admin-rest-api#/">REST</a>
API.</td></tr>
<tr><td><strong>Java Admin API</strong></td><td>The <code>functions</code> method of the <a href="https://pulsar.apache.org/api/admin/2.7.0-SNAPSHOT/org/apache/pulsar/client/admin/PulsarAdmin">PulsarAdmin</a>
object in the <a href="/docs/en/2.7.4/client-libraries-java">Java API</a>.</td></tr>
</tbody>
</table>
<h2><a class="anchor" aria-hidden="true" id="function-resources"></a><a href="#function-resources" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Function resources</h2>
<p>You can perform the following operations on functions.</p>
<h3><a class="anchor" aria-hidden="true" id="create-a-function"></a><a href="#create-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Create a function</h3>
<p>You can create a Pulsar function in cluster mode (deploy it on a Pulsar cluster) using Admin CLI, REST API or Java Admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6388-tab-6389" class="nav-link active" data-group="group_6388" data-tab="tab-group-6388-content-6389">Admin CLI</div><div id="tab-group-6388-tab-6390" class="nav-link" data-group="group_6388" data-tab="tab-group-6388-content-6390">REST API</div><div id="tab-group-6388-tab-6391" class="nav-link" data-group="group_6388" data-tab="tab-group-6388-content-6391">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6388-content-6389" class="tab-pane active" data-group="group_6388" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-create"><code>create</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> create \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) \<br /> --inputs test-input-topic \<br /> --output persistent://public/default/test-output-topic \<br /> --classname org.apache.pulsar.functions.api.examples.ExclamationFunction \<br /> --jar /examples/api-examples.jar<br /></code></pre>
</span></div></div><div id="tab-group-6388-content-6390" class="tab-pane" data-group="group_6388" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName?version=2.7.4&amp;apiVersion=v3"><b>POST</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6388-content-6391" class="tab-pane" data-group="group_6388" tabindex="-1"><div><span><pre><code class="hljs css language-java">FunctionConfig functionConfig = <span class="hljs-keyword">new</span> FunctionConfig();<br />functionConfig.setTenant(tenant);<br />functionConfig.setNamespace(namespace);<br />functionConfig.setName(functionName);<br />functionConfig.setRuntime(FunctionConfig.Runtime.JAVA);<br />functionConfig.setParallelism(<span class="hljs-number">1</span>);<br />functionConfig.setClassName(<span class="hljs-string">"org.apache.pulsar.functions.api.examples.ExclamationFunction"</span>);<br />functionConfig.setProcessingGuarantees(FunctionConfig.ProcessingGuarantees.ATLEAST_ONCE);<br />functionConfig.setTopicsPattern(sourceTopicPattern);<br />functionConfig.setSubName(subscriptionName);<br />functionConfig.setAutoAck(<span class="hljs-keyword">true</span>);<br />functionConfig.setOutput(sinkTopic);<br />admin.functions().createFunction(functionConfig, fileName);<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="update-a-function"></a><a href="#update-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Update a function</h3>
<p>You can update a Pulsar function that has been deployed to a Pulsar cluster using Admin CLI, REST API or Java Admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6392-tab-6393" class="nav-link active" data-group="group_6392" data-tab="tab-group-6392-content-6393">Admin CLI</div><div id="tab-group-6392-tab-6394" class="nav-link" data-group="group_6392" data-tab="tab-group-6392-content-6394">REST Admin API</div><div id="tab-group-6392-tab-6395" class="nav-link" data-group="group_6392" data-tab="tab-group-6392-content-6395">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6392-content-6393" class="tab-pane active" data-group="group_6392" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-update"><code>update</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> update \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) \<br /> --output persistent://public/default/update-output-topic \<br /><span class="hljs-meta"> #</span><span class="bash"> other options</span><br /></code></pre>
</span></div></div><div id="tab-group-6392-content-6394" class="tab-pane" data-group="group_6392" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName?version=2.7.4&amp;apiVersion=v3"><b>PUT</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6392-content-6395" class="tab-pane" data-group="group_6392" tabindex="-1"><div><span><pre><code class="hljs css language-java">FunctionConfig functionConfig = <span class="hljs-keyword">new</span> FunctionConfig();<br />functionConfig.setTenant(tenant);<br />functionConfig.setNamespace(namespace);<br />functionConfig.setName(functionName);<br />functionConfig.setRuntime(FunctionConfig.Runtime.JAVA);<br />functionConfig.setParallelism(<span class="hljs-number">1</span>);<br />functionConfig.setClassName(<span class="hljs-string">"org.apache.pulsar.functions.api.examples.ExclamationFunction"</span>);<br />UpdateOptions updateOptions = <span class="hljs-keyword">new</span> UpdateOptions();<br />updateOptions.setUpdateAuthData(updateAuthData);<br />admin.functions().updateFunction(functionConfig, userCodeFile, updateOptions);<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="start-an-instance-of-a-function"></a><a href="#start-an-instance-of-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Start an instance of a function</h3>
<p>You can start a stopped function instance with <code>instance-id</code> using Admin CLI, REST API or Java Admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6396-tab-6397" class="nav-link active" data-group="group_6396" data-tab="tab-group-6396-content-6397">Admin CLI</div><div id="tab-group-6396-tab-6398" class="nav-link" data-group="group_6396" data-tab="tab-group-6396-content-6398">REST API</div><div id="tab-group-6396-tab-6399" class="nav-link" data-group="group_6396" data-tab="tab-group-6396-content-6399">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6396-content-6397" class="tab-pane active" data-group="group_6396" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-start"><code>start</code></a> subcommand.</p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> start \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) \<br /> --instance-id 1<br /></code></pre>
</span></div></div><div id="tab-group-6396-content-6398" class="tab-pane" data-group="group_6396" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/start?version=2.7.4&amp;apiVersion=v3"><b>POST</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/start?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6396-content-6399" class="tab-pane" data-group="group_6396" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().startFunction(tenant, namespace, functionName, Integer.parseInt(instanceId));<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="start-all-instances-of-a-function"></a><a href="#start-all-instances-of-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Start all instances of a function</h3>
<p>You can start all stopped function instances using Admin CLI, REST API or Java Admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6400-tab-6401" class="nav-link active" data-group="group_6400" data-tab="tab-group-6400-content-6401">Admin CLI</div><div id="tab-group-6400-tab-6402" class="nav-link" data-group="group_6400" data-tab="tab-group-6400-content-6402">REST API</div><div id="tab-group-6400-tab-6403" class="nav-link" data-group="group_6400" data-tab="tab-group-6400-content-6403">Java</div></div><div class="tab-content"><div id="tab-group-6400-content-6401" class="tab-pane active" data-group="group_6400" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-start"><code>start</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> start \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) \<br /></code></pre>
</span></div></div><div id="tab-group-6400-content-6402" class="tab-pane" data-group="group_6400" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName/start?version=2.7.4&amp;apiVersion=v3"><b>POST</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName/start?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6400-content-6403" class="tab-pane" data-group="group_6400" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().startFunction(tenant, namespace, functionName);<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="stop-an-instance-of-a-function"></a><a href="#stop-an-instance-of-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Stop an instance of a function</h3>
<p>You can stop a function instance with <code>instance-id</code> using Admin CLI, REST API or Java Admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6404-tab-6405" class="nav-link active" data-group="group_6404" data-tab="tab-group-6404-content-6405">Admin CLI</div><div id="tab-group-6404-tab-6406" class="nav-link" data-group="group_6404" data-tab="tab-group-6404-content-6406">REST API</div><div id="tab-group-6404-tab-6407" class="nav-link" data-group="group_6404" data-tab="tab-group-6404-content-6407">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6404-content-6405" class="tab-pane active" data-group="group_6404" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-stop"><code>stop</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> stop \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) \<br /> --instance-id 1<br /></code></pre>
</span></div></div><div id="tab-group-6404-content-6406" class="tab-pane" data-group="group_6404" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stop?version=2.7.4&amp;apiVersion=v3"><b>POST</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stop?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6404-content-6407" class="tab-pane" data-group="group_6404" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().stopFunction(tenant, namespace, functionName, Integer.parseInt(instanceId));<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="stop-all-instances-of-a-function"></a><a href="#stop-all-instances-of-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Stop all instances of a function</h3>
<p>You can stop all function instances using Admin CLI, REST API or Java Admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6408-tab-6409" class="nav-link active" data-group="group_6408" data-tab="tab-group-6408-content-6409">Admin CLI</div><div id="tab-group-6408-tab-6410" class="nav-link" data-group="group_6408" data-tab="tab-group-6408-content-6410">REST API</div><div id="tab-group-6408-tab-6411" class="nav-link" data-group="group_6408" data-tab="tab-group-6408-content-6411">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6408-content-6409" class="tab-pane active" data-group="group_6408" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-stop"><code>stop</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> stop \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) \<br /></code></pre>
</span></div></div><div id="tab-group-6408-content-6410" class="tab-pane" data-group="group_6408" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName/stop?version=2.7.4&amp;apiVersion=v3"><b>POST</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName/stop?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6408-content-6411" class="tab-pane" data-group="group_6408" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().stopFunction(tenant, namespace, functionName);<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="restart-an-instance-of-a-function"></a><a href="#restart-an-instance-of-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Restart an instance of a function</h3>
<p>Restart a function instance with <code>instance-id</code> using Admin CLI, REST API or Java Admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6412-tab-6413" class="nav-link active" data-group="group_6412" data-tab="tab-group-6412-content-6413">Admin CLI</div><div id="tab-group-6412-tab-6414" class="nav-link" data-group="group_6412" data-tab="tab-group-6412-content-6414">REST API</div><div id="tab-group-6412-tab-6415" class="nav-link" data-group="group_6412" data-tab="tab-group-6412-content-6415">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6412-content-6413" class="tab-pane active" data-group="group_6412" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-restart"><code>restart</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> restart \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) \<br /> --instance-id 1<br /></code></pre>
</span></div></div><div id="tab-group-6412-content-6414" class="tab-pane" data-group="group_6412" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/restart?version=2.7.4&amp;apiVersion=v3"><b>POST</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/restart?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6412-content-6415" class="tab-pane" data-group="group_6412" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().restartFunction(tenant, namespace, functionName, Integer.parseInt(instanceId));<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="restart-all-instances-of-a-function"></a><a href="#restart-all-instances-of-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Restart all instances of a function</h3>
<p>You can restart all function instances using Admin CLI, REST API or Java admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6416-tab-6417" class="nav-link active" data-group="group_6416" data-tab="tab-group-6416-content-6417">Admin CLI</div><div id="tab-group-6416-tab-6418" class="nav-link" data-group="group_6416" data-tab="tab-group-6416-content-6418">REST API</div><div id="tab-group-6416-tab-6419" class="nav-link" data-group="group_6416" data-tab="tab-group-6416-content-6419">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6416-content-6417" class="tab-pane active" data-group="group_6416" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-restart"><code>restart</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> restart \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) \<br /></code></pre>
</span></div></div><div id="tab-group-6416-content-6418" class="tab-pane" data-group="group_6416" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName/restart?version=2.7.4&amp;apiVersion=v3"><b>POST</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName/restart?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6416-content-6419" class="tab-pane" data-group="group_6416" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().restartFunction(tenant, namespace, functionName);<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="list-all-functions"></a><a href="#list-all-functions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>List all functions</h3>
<p>You can list all Pulsar functions running under a specific tenant and namespace using Admin CLI, REST API or Java Admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6420-tab-6421" class="nav-link active" data-group="group_6420" data-tab="tab-group-6420-content-6421">Admin CLI</div><div id="tab-group-6420-tab-6422" class="nav-link" data-group="group_6420" data-tab="tab-group-6420-content-6422">REST API</div><div id="tab-group-6420-tab-6423" class="nav-link" data-group="group_6420" data-tab="tab-group-6420-content-6423">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6420-content-6421" class="tab-pane active" data-group="group_6420" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-list"><code>list</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> list \</span><br /> --tenant public \<br /> --namespace default<br /></code></pre>
</span></div></div><div id="tab-group-6420-content-6422" class="tab-pane" data-group="group_6420" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace?version=2.7.4&amp;apiVersion=v3"><b>GET</b> <i>/admin/v3/functions/:tenant/:namespace?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6420-content-6423" class="tab-pane" data-group="group_6420" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().getFunctions(tenant, namespace);<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="delete-a-function"></a><a href="#delete-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Delete a function</h3>
<p>You can delete a Pulsar function that is running on a Pulsar cluster using Admin CLI, REST API or Java Admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6424-tab-6425" class="nav-link active" data-group="group_6424" data-tab="tab-group-6424-content-6425">Admin CLI</div><div id="tab-group-6424-tab-6426" class="nav-link" data-group="group_6424" data-tab="tab-group-6424-content-6426">REST API</div><div id="tab-group-6424-tab-6427" class="nav-link" data-group="group_6424" data-tab="tab-group-6424-content-6427">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6424-content-6425" class="tab-pane active" data-group="group_6424" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-delete"><code>delete</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> delete \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) <br /></code></pre>
</span></div></div><div id="tab-group-6424-content-6426" class="tab-pane" data-group="group_6424" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName?version=2.7.4&amp;apiVersion=v3"><b>DELETE</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6424-content-6427" class="tab-pane" data-group="group_6424" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().deleteFunction(tenant, namespace, functionName);<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="get-info-about-a-function"></a><a href="#get-info-about-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Get info about a function</h3>
<p>You can get information about a Pulsar function currently running in cluster mode using Admin CLI, REST API or Java Admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6428-tab-6429" class="nav-link active" data-group="group_6428" data-tab="tab-group-6428-content-6429">Admin CLI</div><div id="tab-group-6428-tab-6430" class="nav-link" data-group="group_6428" data-tab="tab-group-6428-content-6430">REST API</div><div id="tab-group-6428-tab-6431" class="nav-link" data-group="group_6428" data-tab="tab-group-6428-content-6431">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6428-content-6429" class="tab-pane active" data-group="group_6428" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-get"><code>get</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> get \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) <br /></code></pre>
</span></div></div><div id="tab-group-6428-content-6430" class="tab-pane" data-group="group_6428" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName?version=2.7.4&amp;apiVersion=v3"><b>GET</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6428-content-6431" class="tab-pane" data-group="group_6428" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().getFunction(tenant, namespace, functionName);<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="get-status-of-an-instance-of-a-function"></a><a href="#get-status-of-an-instance-of-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Get status of an instance of a function</h3>
<p>You can get the current status of a Pulsar function instance with <code>instance-id</code> using Admin CLI, REST API or Java Admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6432-tab-6433" class="nav-link active" data-group="group_6432" data-tab="tab-group-6432-content-6433">Admin CLI</div><div id="tab-group-6432-tab-6434" class="nav-link" data-group="group_6432" data-tab="tab-group-6432-content-6434">REST API</div><div id="tab-group-6432-tab-6435" class="nav-link" data-group="group_6432" data-tab="tab-group-6432-content-6435">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6432-content-6433" class="tab-pane active" data-group="group_6432" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-status"><code>status</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> status \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) \<br /> --instance-id 1<br /></code></pre>
</span></div></div><div id="tab-group-6432-content-6434" class="tab-pane" data-group="group_6432" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/status?version=2.7.4&amp;apiVersion=v3"><b>GET</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/status?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6432-content-6435" class="tab-pane" data-group="group_6432" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().getFunctionStatus(tenant, namespace, functionName, Integer.parseInt(instanceId));<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="get-status-of-all-instances-of-a-function"></a><a href="#get-status-of-all-instances-of-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Get status of all instances of a function</h3>
<p>You can get the current status of a Pulsar function instance using Admin CLI, REST API or Java Admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6436-tab-6437" class="nav-link active" data-group="group_6436" data-tab="tab-group-6436-content-6437">Admin CLI</div><div id="tab-group-6436-tab-6438" class="nav-link" data-group="group_6436" data-tab="tab-group-6436-content-6438">REST API</div><div id="tab-group-6436-tab-6439" class="nav-link" data-group="group_6436" data-tab="tab-group-6436-content-6439">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6436-content-6437" class="tab-pane active" data-group="group_6436" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-status"><code>status</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> status \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) <br /></code></pre>
</span></div></div><div id="tab-group-6436-content-6438" class="tab-pane" data-group="group_6436" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName/status?version=2.7.4&amp;apiVersion=v3"><b>GET</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName/status?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6436-content-6439" class="tab-pane" data-group="group_6436" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().getFunctionStatus(tenant, namespace, functionName);<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="get-stats-of-an-instance-of-a-function"></a><a href="#get-stats-of-an-instance-of-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Get stats of an instance of a function</h3>
<p>You can get the current stats of a Pulsar Function instance with <code>instance-id</code> using Admin CLI, REST API or Java admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6440-tab-6441" class="nav-link active" data-group="group_6440" data-tab="tab-group-6440-content-6441">Admin CLI</div><div id="tab-group-6440-tab-6442" class="nav-link" data-group="group_6440" data-tab="tab-group-6440-content-6442">REST API</div><div id="tab-group-6440-tab-6443" class="nav-link" data-group="group_6440" data-tab="tab-group-6440-content-6443">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6440-content-6441" class="tab-pane active" data-group="group_6440" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-stats"><code>stats</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> stats \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) \<br /> --instance-id 1<br /></code></pre>
</span></div></div><div id="tab-group-6440-content-6442" class="tab-pane" data-group="group_6440" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stats?version=2.7.4&amp;apiVersion=v3"><b>GET</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stats?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6440-content-6443" class="tab-pane" data-group="group_6440" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().getFunctionStats(tenant, namespace, functionName, Integer.parseInt(instanceId));<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="get-stats-of-all-instances-of-a-function"></a><a href="#get-stats-of-all-instances-of-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Get stats of all instances of a function</h3>
<p>You can get the current stats of a Pulsar function using Admin CLI, REST API or Java admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6444-tab-6445" class="nav-link active" data-group="group_6444" data-tab="tab-group-6444-content-6445">Admin CLI</div><div id="tab-group-6444-tab-6446" class="nav-link" data-group="group_6444" data-tab="tab-group-6444-content-6446">REST API</div><div id="tab-group-6444-tab-6447" class="nav-link" data-group="group_6444" data-tab="tab-group-6444-content-6447">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6444-content-6445" class="tab-pane active" data-group="group_6444" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-stats"><code>stats</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> stats \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) <br /></code></pre>
</span></div></div><div id="tab-group-6444-content-6446" class="tab-pane" data-group="group_6444" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName/stats?version=2.7.4&amp;apiVersion=v3"><b>GET</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName/stats?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6444-content-6447" class="tab-pane" data-group="group_6444" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().getFunctionStats(tenant, namespace, functionName);<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="trigger-a-function"></a><a href="#trigger-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Trigger a function</h3>
<p>You can trigger a specified Pulsar function with a supplied value using Admin CLI, REST API or Java admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6448-tab-6449" class="nav-link active" data-group="group_6448" data-tab="tab-group-6448-content-6449">Admin CLI</div><div id="tab-group-6448-tab-6450" class="nav-link" data-group="group_6448" data-tab="tab-group-6448-content-6450">REST API</div><div id="tab-group-6448-tab-6451" class="nav-link" data-group="group_6448" data-tab="tab-group-6448-content-6451">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6448-content-6449" class="tab-pane active" data-group="group_6448" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-trigger"><code>trigger</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> trigger \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) \<br /> --topic (the name of input topic) \<br /> --trigger-value \"hello pulsar\"<br /><span class="hljs-meta"> #</span><span class="bash"> or --trigger-file (the path of trigger file)</span><br /></code></pre>
</span></div></div><div id="tab-group-6448-content-6450" class="tab-pane" data-group="group_6448" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName/trigger?version=2.7.4&amp;apiVersion=v3"><b>POST</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName/trigger?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6448-content-6451" class="tab-pane" data-group="group_6448" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().triggerFunction(tenant, namespace, functionName, topic, triggerValue, triggerFile);<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="put-state-associated-with-a-function"></a><a href="#put-state-associated-with-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Put state associated with a function</h3>
<p>You can put the state associated with a Pulsar function using Admin CLI, REST API or Java admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6452-tab-6453" class="nav-link active" data-group="group_6452" data-tab="tab-group-6452-content-6453">Admin CLI</div><div id="tab-group-6452-tab-6454" class="nav-link" data-group="group_6452" data-tab="tab-group-6452-content-6454">REST API</div><div id="tab-group-6452-tab-6455" class="nav-link" data-group="group_6452" data-tab="tab-group-6452-content-6455">Java Admin API</div></div><div class="tab-content"><div id="tab-group-6452-content-6453" class="tab-pane active" data-group="group_6452" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-putstate"><code>putstate</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> putstate \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) \<br /> --state "{\"key\":\"pulsar\", \"stringValue\":\"hello pulsar\"}" <br /></code></pre>
</span></div></div><div id="tab-group-6452-content-6454" class="tab-pane" data-group="group_6452" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName/state/:key?version=2.7.4&amp;apiVersion=v3"><b>POST</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName/state/:key?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6452-content-6455" class="tab-pane" data-group="group_6452" tabindex="-1"><div><span><pre><code class="hljs css language-java">TypeReference&lt;FunctionState&gt; typeRef = <span class="hljs-keyword">new</span> TypeReference&lt;FunctionState&gt;() {};<br />FunctionState stateRepr = ObjectMapperFactory.getThreadLocal().readValue(state, typeRef);<br />admin.functions().putFunctionState(tenant, namespace, functionName, stateRepr);<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="fetch-state-associated-with-a-function"></a><a href="#fetch-state-associated-with-a-function" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Fetch state associated with a function</h3>
<p>You can fetch the current state associated with a Pulsar function using Admin CLI, REST API or Java admin API.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-6456-tab-6457" class="nav-link active" data-group="group_6456" data-tab="tab-group-6456-content-6457">Admin CLI</div><div id="tab-group-6456-tab-6458" class="nav-link" data-group="group_6456" data-tab="tab-group-6456-content-6458">REST API</div><div id="tab-group-6456-tab-6459" class="nav-link" data-group="group_6456" data-tab="tab-group-6456-content-6459">Java Admin CLI</div></div><div class="tab-content"><div id="tab-group-6456-content-6457" class="tab-pane active" data-group="group_6456" tabindex="-1"><div><span><p>Use the <a href="/docs/en/2.7.4/reference-pulsar-admin#functions-querystate"><code>querystate</code></a> subcommand.</p>
<p><strong>Example</strong></p>
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> pulsar-admin <span class="hljs-built_in">functions</span> querystate \</span><br /> --tenant public \<br /> --namespace default \<br /> --name (the name of Pulsar Functions) \<br /> --key (the key of state) <br /></code></pre>
</span></div></div><div id="tab-group-6456-content-6458" class="tab-pane" data-group="group_6456" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/functions-rest-api#/admin/v3/functions/:tenant/:namespace/:functionName/state/:key?version=2.7.4&amp;apiVersion=v3"><b>GET</b> <i>/admin/v3/functions/:tenant/:namespace/:functionName/state/:key?version=2.7.4</i></a>
</p>
</span></div></div><div id="tab-group-6456-content-6459" class="tab-pane" data-group="group_6456" tabindex="-1"><div><span><pre><code class="hljs css language-java">admin.functions().getFunctionState(tenant, namespace, functionName, key);<br /></code></pre>
</span></div></div></div></div>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/2.7.4/admin-api-topics"><span class="arrow-prev">← </span><span>Topics</span></a><a class="docs-next button" href="/docs/en/2.7.4/adaptors-kafka"><span>Kafka client wrapper</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#function-resources">Function resources</a><ul class="toc-headings"><li><a href="#create-a-function">Create a function</a></li><li><a href="#update-a-function">Update a function</a></li><li><a href="#start-an-instance-of-a-function">Start an instance of a function</a></li><li><a href="#start-all-instances-of-a-function">Start all instances of a function</a></li><li><a href="#stop-an-instance-of-a-function">Stop an instance of a function</a></li><li><a href="#stop-all-instances-of-a-function">Stop all instances of a function</a></li><li><a href="#restart-an-instance-of-a-function">Restart an instance of a function</a></li><li><a href="#restart-all-instances-of-a-function">Restart all instances of a function</a></li><li><a href="#list-all-functions">List all functions</a></li><li><a href="#delete-a-function">Delete a function</a></li><li><a href="#get-info-about-a-function">Get info about a function</a></li><li><a href="#get-status-of-an-instance-of-a-function">Get status of an instance of a function</a></li><li><a href="#get-status-of-all-instances-of-a-function">Get status of all instances of a function</a></li><li><a href="#get-stats-of-an-instance-of-a-function">Get stats of an instance of a function</a></li><li><a href="#get-stats-of-all-instances-of-a-function">Get stats of all instances of a function</a></li><li><a href="#trigger-a-function">Trigger a function</a></li><li><a href="#put-state-associated-with-a-function">Put state associated with a function</a></li><li><a href="#fetch-state-associated-with-a-function">Fetch state associated with a function</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2022 The Apache Software Foundation. All Rights Reserved. Apache, Apache Pulsar and the Apache feather logo are trademarks of The Apache Software Foundation.</section><span><script>
const community = document.querySelector("a[href='#community']").parentNode;
const communityMenu =
'<li>' +
'<a id="community-menu" href="#">Community <span style="font-size: 0.75em">&nbsp;▼</span></a>' +
'<div id="community-dropdown" class="hide">' +
'<ul id="community-dropdown-items">' +
'<li><a href="/en/contact">Contact</a></li>' +
'<li><a href="/en/contributing">Contributing</a></li>' +
'<li><a href="/en/coding-guide">Coding guide</a></li>' +
'<li><a href="/en/events">Events</a></li>' +
'<li><a href="https://twitter.com/Apache_Pulsar" target="_blank">Twitter &#x2750</a></li>' +
'<li><a href="https://github.com/apache/pulsar/wiki" target="_blank">Wiki &#x2750</a></li>' +
'<li><a href="https://github.com/apache/pulsar/issues" target="_blank">Issue tracking &#x2750</a></li>' +
'<li><a href="https://pulsar-summit.org/" target="_blank">Pulsar Summit &#x2750</a></li>' +
'<li>&nbsp;</li>' +
'<li><a href="/en/resources">Resources</a></li>' +
'<li><a href="/en/team">Team</a></li>' +
'<li><a href="/en/powered-by">Powered By</a></li>' +
'</ul>' +
'</div>' +
'</li>';
community.innerHTML = communityMenu;
const communityMenuItem = document.getElementById("community-menu");
const communityDropDown = document.getElementById("community-dropdown");
communityMenuItem.addEventListener("click", function(event) {
event.preventDefault();
if (communityDropDown.className == 'hide') {
communityDropDown.className = 'visible';
} else {
communityDropDown.className = 'hide';
}
});
</script></span></footer></div><script>window.twttr=(function(d,s, id){var js,fjs=d.getElementsByTagName(s)[0],t=window.twttr||{};if(d.getElementById(id))return t;js=d.createElement(s);js.id=id;js.src='https://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js, fjs);t._e = [];t.ready = function(f) {t._e.push(f);};return t;}(document, 'script', 'twitter-wjs'));</script></body></html>