java-sdk/docs/io/dapr/actors/runtime/ActorRuntimeConfig.html

354 lines
15 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (13.0.2) on Tue Jun 09 14:27:52 PDT 2020 -->
<title>ActorRuntimeConfig (dapr-sdk-parent 0.6.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-06-09">
<meta name="description" content="declaration: package: io.dapr.actors.runtime, class: ActorRuntimeConfig">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
</head>
<body class="class-declaration">
<script type="text/javascript">var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ActorRuntimeConfig.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="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<a id="skip.navbar.top">
<!-- -->
</a>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">io.dapr.actors.runtime</a></div>
<h1 title="Class ActorRuntimeConfig" class="title">Class ActorRuntimeConfig</h1>
</div>
<div class="contentContainer">
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance">io.dapr.actors.runtime.ActorRuntimeConfig</div>
</div>
<section class="description">
<hr>
<pre>public class <span class="typeNameLabel">ActorRuntimeConfig</span>
extends java.lang.Object</pre>
<div class="block">Represents the configuration for the Actor Runtime.</div>
</section>
<section class="summary">
<ul class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>java.time.Duration</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getActorIdleTimeout()">getActorIdleTimeout</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the duration for Actors' timeout.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>java.time.Duration</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getActorScanInterval()">getActorScanInterval</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the duration to scan for Actors.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDrainBalancedActors()">getDrainBalancedActors</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets whether balanced actors should be drained.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>java.time.Duration</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDrainOngoingCallTimeout()">getDrainOngoingCallTimeout</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the timeout to drain ongoing calls.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="ActorRuntimeConfig.html" title="class in io.dapr.actors.runtime">ActorRuntimeConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setActorIdleTimeout(java.time.Duration)">setActorIdleTimeout</a></span>&#8203;(java.time.Duration&nbsp;actorIdleTimeout)</code></th>
<td class="colLast">
<div class="block">Sets the duration for Actors' timeout.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code><a href="ActorRuntimeConfig.html" title="class in io.dapr.actors.runtime">ActorRuntimeConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setActorScanInterval(java.time.Duration)">setActorScanInterval</a></span>&#8203;(java.time.Duration&nbsp;actorScanInterval)</code></th>
<td class="colLast">
<div class="block">Sets the duration to scan for Actors.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code><a href="ActorRuntimeConfig.html" title="class in io.dapr.actors.runtime">ActorRuntimeConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDrainBalancedActors(java.lang.Boolean)">setDrainBalancedActors</a></span>&#8203;(java.lang.Boolean&nbsp;drainBalancedActors)</code></th>
<td class="colLast">
<div class="block">Sets whether balanced actors should be drained.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code><a href="ActorRuntimeConfig.html" title="class in io.dapr.actors.runtime">ActorRuntimeConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDrainOngoingCallTimeout(java.time.Duration)">setDrainOngoingCallTimeout</a></span>&#8203;(java.time.Duration&nbsp;drainOngoingCallTimeout)</code></th>
<td class="colLast">
<div class="block">Sets the timeout to drain ongoing calls.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a><code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<li class="blockList">
<section class="methodDetails"><a id="method.detail">
<!-- -->
</a>
<h2>Method Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="getActorIdleTimeout()">getActorIdleTimeout</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">java.time.Duration</span>&nbsp;<span class="memberName">getActorIdleTimeout</span>()</div>
<div class="block">Gets the duration for Actors' timeout.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Duration for Actors' timeout.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="setActorIdleTimeout(java.time.Duration)">setActorIdleTimeout</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="ActorRuntimeConfig.html" title="class in io.dapr.actors.runtime">ActorRuntimeConfig</a></span>&nbsp;<span class="memberName">setActorIdleTimeout</span>&#8203;(<span class="arguments">java.time.Duration&nbsp;actorIdleTimeout)</span></div>
<div class="block">Sets the duration for Actors' timeout.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>actorIdleTimeout</code> - Duration for Actors' timeout.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This instance.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getActorScanInterval()">getActorScanInterval</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">java.time.Duration</span>&nbsp;<span class="memberName">getActorScanInterval</span>()</div>
<div class="block">Gets the duration to scan for Actors.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The duration to scan for Actors.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="setActorScanInterval(java.time.Duration)">setActorScanInterval</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="ActorRuntimeConfig.html" title="class in io.dapr.actors.runtime">ActorRuntimeConfig</a></span>&nbsp;<span class="memberName">setActorScanInterval</span>&#8203;(<span class="arguments">java.time.Duration&nbsp;actorScanInterval)</span></div>
<div class="block">Sets the duration to scan for Actors.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>actorScanInterval</code> - The duration to scan for Actors.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This instance.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getDrainOngoingCallTimeout()">getDrainOngoingCallTimeout</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">java.time.Duration</span>&nbsp;<span class="memberName">getDrainOngoingCallTimeout</span>()</div>
<div class="block">Gets the timeout to drain ongoing calls.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The timeout to drain ongoing calls.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="setDrainOngoingCallTimeout(java.time.Duration)">setDrainOngoingCallTimeout</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="ActorRuntimeConfig.html" title="class in io.dapr.actors.runtime">ActorRuntimeConfig</a></span>&nbsp;<span class="memberName">setDrainOngoingCallTimeout</span>&#8203;(<span class="arguments">java.time.Duration&nbsp;drainOngoingCallTimeout)</span></div>
<div class="block">Sets the timeout to drain ongoing calls.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>drainOngoingCallTimeout</code> - The timeout to drain ongoing calls.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This instance.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getDrainBalancedActors()">getDrainBalancedActors</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">java.lang.Boolean</span>&nbsp;<span class="memberName">getDrainBalancedActors</span>()</div>
<div class="block">Gets whether balanced actors should be drained.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether balanced actors should be drained.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="setDrainBalancedActors(java.lang.Boolean)">setDrainBalancedActors</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="ActorRuntimeConfig.html" title="class in io.dapr.actors.runtime">ActorRuntimeConfig</a></span>&nbsp;<span class="memberName">setDrainBalancedActors</span>&#8203;(<span class="arguments">java.lang.Boolean&nbsp;drainBalancedActors)</span></div>
<div class="block">Sets whether balanced actors should be drained.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>drainBalancedActors</code> - Whether balanced actors should be drained.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This instance.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ActorRuntimeConfig.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="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2020. All rights reserved.</small></p>
</footer>
</body>
</html>