blob: bd27cb02b9e56afb5988b2f61504300f415a144b [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>RedisClusterMapState (Storm 2.6.2 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: org.apache.storm.redis.trident.state, class: RedisClusterMapState">
<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.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/RedisClusterMapState.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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.storm.redis.trident.state</a></div>
<h1 title="Class RedisClusterMapState" class="title">Class RedisClusterMapState&lt;T&gt;</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="AbstractRedisMapState.html" title="class in org.apache.storm.redis.trident.state">org.apache.storm.redis.trident.state.AbstractRedisMapState</a>&lt;T&gt;
<div class="inheritance">org.apache.storm.redis.trident.state.RedisClusterMapState&lt;T&gt;</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - value's type class</dd>
</dl>
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../../trident/state/map/IBackingMap.html" title="interface in org.apache.storm.trident.state.map">IBackingMap</a>&lt;T&gt;</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RedisClusterMapState&lt;T&gt;</span>
<span class="extends-implements">extends <a href="AbstractRedisMapState.html" title="class in org.apache.storm.redis.trident.state">AbstractRedisMapState</a>&lt;T&gt;</span></div>
<div class="block">IBackingMap implementation for Redis Cluster environment.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="AbstractRedisMapState.html" title="class in org.apache.storm.redis.trident.state"><code>AbstractRedisMapState</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="RedisClusterMapState.Factory.html" class="type-name-link" title="class in org.apache.storm.redis.trident.state">RedisClusterMapState.Factory</a></code></div>
<div class="col-last even-row-color">
<div class="block">RedisClusterMapState.Factory provides Redis Cluster environment version of StateFactory.</div>
</div>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.storm.redis.trident.state.AbstractRedisMapState">Fields inherited from class&nbsp;org.apache.storm.redis.trident.state.<a href="AbstractRedisMapState.html" title="class in org.apache.storm.redis.trident.state">AbstractRedisMapState</a></h3>
<code><a href="AbstractRedisMapState.html#DEFAULT_SERIALIZERS">DEFAULT_SERIALIZERS</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(redis.clients.jedis.JedisCluster,org.apache.storm.redis.trident.state.Options,org.apache.storm.trident.state.Serializer,org.apache.storm.redis.trident.state.KeyFactory)" class="member-name-link">RedisClusterMapState</a><wbr>(redis.clients.jedis.JedisCluster&nbsp;jedisCluster,
<a href="Options.html" title="class in org.apache.storm.redis.trident.state">Options</a>&nbsp;options,
<a href="../../../trident/state/Serializer.html" title="interface in org.apache.storm.trident.state">Serializer</a>&lt;<a href="RedisClusterMapState.html" title="type parameter in RedisClusterMapState">T</a>&gt;&nbsp;serializer,
<a href="KeyFactory.html" title="interface in org.apache.storm.redis.trident.state">KeyFactory</a>&nbsp;keyFactory)</code></div>
<div class="col-last even-row-color">
<div class="block">Constructor.</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<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>protected <a href="KeyFactory.html" title="interface in org.apache.storm.redis.trident.state">KeyFactory</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getKeyFactory()" class="member-name-link">getKeyFactory</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns KeyFactory which is used for converting state key -> Redis key.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../../../trident/state/Serializer.html" title="interface in org.apache.storm.trident.state">Serializer</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSerializer()" class="member-name-link">getSerializer</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns Serializer which is used for serializing tuple value and deserializing Redis value.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#nonTransactional(org.apache.storm.redis.common.config.JedisClusterConfig)" class="member-name-link">nonTransactional</a><wbr>(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Provides StateFactory for non transactional.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#nonTransactional(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.common.mapper.RedisDataTypeDescription)" class="member-name-link">nonTransactional</a><wbr>(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="../../common/mapper/RedisDataTypeDescription.html" title="class in org.apache.storm.redis.common.mapper">RedisDataTypeDescription</a>&nbsp;dataTypeDescription)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Provides StateFactory for non transactional.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#nonTransactional(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.trident.state.KeyFactory)" class="member-name-link">nonTransactional</a><wbr>(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="KeyFactory.html" title="interface in org.apache.storm.redis.trident.state">KeyFactory</a>&nbsp;factory)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Provides StateFactory for non transactional.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#nonTransactional(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.trident.state.Options)" class="member-name-link">nonTransactional</a><wbr>(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="Options.html" title="class in org.apache.storm.redis.trident.state">Options</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;opts)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Provides StateFactory for non transactional.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#opaque(org.apache.storm.redis.common.config.JedisClusterConfig)" class="member-name-link">opaque</a><wbr>(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Provides StateFactory for opaque transactional.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#opaque(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.common.mapper.RedisDataTypeDescription)" class="member-name-link">opaque</a><wbr>(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="../../common/mapper/RedisDataTypeDescription.html" title="class in org.apache.storm.redis.common.mapper">RedisDataTypeDescription</a>&nbsp;dataTypeDescription)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Provides StateFactory for opaque transactional.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#opaque(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.trident.state.KeyFactory)" class="member-name-link">opaque</a><wbr>(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="KeyFactory.html" title="interface in org.apache.storm.redis.trident.state">KeyFactory</a>&nbsp;factory)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Provides StateFactory for opaque transactional.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#opaque(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.trident.state.Options)" class="member-name-link">opaque</a><wbr>(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="Options.html" title="class in org.apache.storm.redis.trident.state">Options</a>&lt;<a href="../../../trident/state/OpaqueValue.html" title="class in org.apache.storm.trident.state">OpaqueValue</a>&gt;&nbsp;opts)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Provides StateFactory for opaque transactional.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#retrieveValuesFromRedis(java.util.List)" class="member-name-link">retrieveValuesFromRedis</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;keys)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Retrieves values from Redis that each value is corresponding to each key.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#transactional(org.apache.storm.redis.common.config.JedisClusterConfig)" class="member-name-link">transactional</a><wbr>(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Provides StateFactory for transactional.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#transactional(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.common.mapper.RedisDataTypeDescription)" class="member-name-link">transactional</a><wbr>(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="../../common/mapper/RedisDataTypeDescription.html" title="class in org.apache.storm.redis.common.mapper">RedisDataTypeDescription</a>&nbsp;dataTypeDescription)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Provides StateFactory for transactional.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#transactional(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.trident.state.KeyFactory)" class="member-name-link">transactional</a><wbr>(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="KeyFactory.html" title="interface in org.apache.storm.redis.trident.state">KeyFactory</a>&nbsp;factory)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Provides StateFactory for transactional.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#transactional(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.trident.state.Options)" class="member-name-link">transactional</a><wbr>(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="Options.html" title="class in org.apache.storm.redis.trident.state">Options</a>&lt;<a href="../../../trident/state/TransactionalValue.html" title="class in org.apache.storm.trident.state">TransactionalValue</a>&gt;&nbsp;opts)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Provides StateFactory for transactional.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateStatesToRedis(java.util.Map)" class="member-name-link">updateStatesToRedis</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;keyValues)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Updates (key, value) pairs to Redis.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.storm.redis.trident.state.AbstractRedisMapState">Methods inherited from class&nbsp;org.apache.storm.redis.trident.state.<a href="AbstractRedisMapState.html" title="class in org.apache.storm.redis.trident.state">AbstractRedisMapState</a></h3>
<code><a href="AbstractRedisMapState.html#multiGet(java.util.List)">multiGet</a>, <a href="AbstractRedisMapState.html#multiPut(java.util.List,java.util.List)">multiPut</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(redis.clients.jedis.JedisCluster,org.apache.storm.redis.trident.state.Options,org.apache.storm.trident.state.Serializer,org.apache.storm.redis.trident.state.KeyFactory)">
<h3>RedisClusterMapState</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RedisClusterMapState</span><wbr><span class="parameters">(redis.clients.jedis.JedisCluster&nbsp;jedisCluster,
<a href="Options.html" title="class in org.apache.storm.redis.trident.state">Options</a>&nbsp;options,
<a href="../../../trident/state/Serializer.html" title="interface in org.apache.storm.trident.state">Serializer</a>&lt;<a href="RedisClusterMapState.html" title="type parameter in RedisClusterMapState">T</a>&gt;&nbsp;serializer,
<a href="KeyFactory.html" title="interface in org.apache.storm.redis.trident.state">KeyFactory</a>&nbsp;keyFactory)</span></div>
<div class="block">Constructor.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jedisCluster</code> - JedisCluster</dd>
<dd><code>options</code> - options of State</dd>
<dd><code>serializer</code> - Serializer</dd>
<dd><code>keyFactory</code> - KeyFactory</dd>
</dl>
</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="opaque(org.apache.storm.redis.common.config.JedisClusterConfig)">
<h3>opaque</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></span>&nbsp;<span class="element-name">opaque</span><wbr><span class="parameters">(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig)</span></div>
<div class="block">Provides StateFactory for opaque transactional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jedisClusterConfig</code> - configuration for JedisCluster</dd>
<dt>Returns:</dt>
<dd>StateFactory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="opaque(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.common.mapper.RedisDataTypeDescription)">
<h3>opaque</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></span>&nbsp;<span class="element-name">opaque</span><wbr><span class="parameters">(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="../../common/mapper/RedisDataTypeDescription.html" title="class in org.apache.storm.redis.common.mapper">RedisDataTypeDescription</a>&nbsp;dataTypeDescription)</span></div>
<div class="block">Provides StateFactory for opaque transactional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jedisClusterConfig</code> - configuration for JedisCluster</dd>
<dd><code>dataTypeDescription</code> - definition of data type</dd>
<dt>Returns:</dt>
<dd>StateFactory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="opaque(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.trident.state.KeyFactory)">
<h3>opaque</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></span>&nbsp;<span class="element-name">opaque</span><wbr><span class="parameters">(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="KeyFactory.html" title="interface in org.apache.storm.redis.trident.state">KeyFactory</a>&nbsp;factory)</span></div>
<div class="block">Provides StateFactory for opaque transactional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jedisClusterConfig</code> - configuration for JedisCluster</dd>
<dd><code>factory</code> - key factory</dd>
<dt>Returns:</dt>
<dd>StateFactory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="opaque(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.trident.state.Options)">
<h3>opaque</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></span>&nbsp;<span class="element-name">opaque</span><wbr><span class="parameters">(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="Options.html" title="class in org.apache.storm.redis.trident.state">Options</a>&lt;<a href="../../../trident/state/OpaqueValue.html" title="class in org.apache.storm.trident.state">OpaqueValue</a>&gt;&nbsp;opts)</span></div>
<div class="block">Provides StateFactory for opaque transactional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jedisClusterConfig</code> - configuration for JedisCluster</dd>
<dd><code>opts</code> - options of State</dd>
<dt>Returns:</dt>
<dd>StateFactory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="transactional(org.apache.storm.redis.common.config.JedisClusterConfig)">
<h3>transactional</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></span>&nbsp;<span class="element-name">transactional</span><wbr><span class="parameters">(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig)</span></div>
<div class="block">Provides StateFactory for transactional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jedisClusterConfig</code> - configuration for JedisCluster</dd>
<dt>Returns:</dt>
<dd>StateFactory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="transactional(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.common.mapper.RedisDataTypeDescription)">
<h3>transactional</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></span>&nbsp;<span class="element-name">transactional</span><wbr><span class="parameters">(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="../../common/mapper/RedisDataTypeDescription.html" title="class in org.apache.storm.redis.common.mapper">RedisDataTypeDescription</a>&nbsp;dataTypeDescription)</span></div>
<div class="block">Provides StateFactory for transactional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jedisClusterConfig</code> - configuration for JedisCluster</dd>
<dd><code>dataTypeDescription</code> - definition of data type</dd>
<dt>Returns:</dt>
<dd>StateFactory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="transactional(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.trident.state.KeyFactory)">
<h3>transactional</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></span>&nbsp;<span class="element-name">transactional</span><wbr><span class="parameters">(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="KeyFactory.html" title="interface in org.apache.storm.redis.trident.state">KeyFactory</a>&nbsp;factory)</span></div>
<div class="block">Provides StateFactory for transactional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jedisClusterConfig</code> - configuration for JedisCluster</dd>
<dd><code>factory</code> - key factory</dd>
<dt>Returns:</dt>
<dd>StateFactory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="transactional(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.trident.state.Options)">
<h3>transactional</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></span>&nbsp;<span class="element-name">transactional</span><wbr><span class="parameters">(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="Options.html" title="class in org.apache.storm.redis.trident.state">Options</a>&lt;<a href="../../../trident/state/TransactionalValue.html" title="class in org.apache.storm.trident.state">TransactionalValue</a>&gt;&nbsp;opts)</span></div>
<div class="block">Provides StateFactory for transactional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jedisClusterConfig</code> - configuration for JedisCluster</dd>
<dd><code>opts</code> - options of State</dd>
<dt>Returns:</dt>
<dd>StateFactory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="nonTransactional(org.apache.storm.redis.common.config.JedisClusterConfig)">
<h3>nonTransactional</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></span>&nbsp;<span class="element-name">nonTransactional</span><wbr><span class="parameters">(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig)</span></div>
<div class="block">Provides StateFactory for non transactional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jedisClusterConfig</code> - configuration for JedisCluster</dd>
<dt>Returns:</dt>
<dd>StateFactory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="nonTransactional(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.common.mapper.RedisDataTypeDescription)">
<h3>nonTransactional</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></span>&nbsp;<span class="element-name">nonTransactional</span><wbr><span class="parameters">(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="../../common/mapper/RedisDataTypeDescription.html" title="class in org.apache.storm.redis.common.mapper">RedisDataTypeDescription</a>&nbsp;dataTypeDescription)</span></div>
<div class="block">Provides StateFactory for non transactional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jedisClusterConfig</code> - configuration for JedisCluster</dd>
<dd><code>dataTypeDescription</code> - definition of data type</dd>
<dt>Returns:</dt>
<dd>StateFactory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="nonTransactional(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.trident.state.KeyFactory)">
<h3>nonTransactional</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></span>&nbsp;<span class="element-name">nonTransactional</span><wbr><span class="parameters">(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="KeyFactory.html" title="interface in org.apache.storm.redis.trident.state">KeyFactory</a>&nbsp;factory)</span></div>
<div class="block">Provides StateFactory for non transactional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jedisClusterConfig</code> - configuration for JedisCluster</dd>
<dd><code>factory</code> - key factory</dd>
<dt>Returns:</dt>
<dd>StateFactory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="nonTransactional(org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.redis.trident.state.Options)">
<h3>nonTransactional</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../../../trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state">StateFactory</a></span>&nbsp;<span class="element-name">nonTransactional</span><wbr><span class="parameters">(<a href="../../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a>&nbsp;jedisClusterConfig,
<a href="Options.html" title="class in org.apache.storm.redis.trident.state">Options</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;opts)</span></div>
<div class="block">Provides StateFactory for non transactional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>jedisClusterConfig</code> - configuration for JedisCluster</dd>
<dd><code>opts</code> - options of State</dd>
<dt>Returns:</dt>
<dd>StateFactory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSerializer()">
<h3>getSerializer</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../../../trident/state/Serializer.html" title="interface in org.apache.storm.trident.state">Serializer</a></span>&nbsp;<span class="element-name">getSerializer</span>()</div>
<div class="block">Returns Serializer which is used for serializing tuple value and deserializing Redis value.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="AbstractRedisMapState.html#getSerializer()">getSerializer</a></code>&nbsp;in class&nbsp;<code><a href="AbstractRedisMapState.html" title="class in org.apache.storm.redis.trident.state">AbstractRedisMapState</a>&lt;<a href="RedisClusterMapState.html" title="type parameter in RedisClusterMapState">T</a>&gt;</code></dd>
<dt>Returns:</dt>
<dd>serializer</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getKeyFactory()">
<h3>getKeyFactory</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="KeyFactory.html" title="interface in org.apache.storm.redis.trident.state">KeyFactory</a></span>&nbsp;<span class="element-name">getKeyFactory</span>()</div>
<div class="block">Returns KeyFactory which is used for converting state key -> Redis key.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="AbstractRedisMapState.html#getKeyFactory()">getKeyFactory</a></code>&nbsp;in class&nbsp;<code><a href="AbstractRedisMapState.html" title="class in org.apache.storm.redis.trident.state">AbstractRedisMapState</a>&lt;<a href="RedisClusterMapState.html" title="type parameter in RedisClusterMapState">T</a>&gt;</code></dd>
<dt>Returns:</dt>
<dd>key factory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="retrieveValuesFromRedis(java.util.List)">
<h3>retrieveValuesFromRedis</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">retrieveValuesFromRedis</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;keys)</span></div>
<div class="block">Retrieves values from Redis that each value is corresponding to each key.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="AbstractRedisMapState.html#retrieveValuesFromRedis(java.util.List)">retrieveValuesFromRedis</a></code>&nbsp;in class&nbsp;<code><a href="AbstractRedisMapState.html" title="class in org.apache.storm.redis.trident.state">AbstractRedisMapState</a>&lt;<a href="RedisClusterMapState.html" title="type parameter in RedisClusterMapState">T</a>&gt;</code></dd>
<dt>Parameters:</dt>
<dd><code>keys</code> - keys having state values</dd>
<dt>Returns:</dt>
<dd>values which are corresponding to keys</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="updateStatesToRedis(java.util.Map)">
<h3>updateStatesToRedis</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">updateStatesToRedis</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;keyValues)</span></div>
<div class="block">Updates (key, value) pairs to Redis.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="AbstractRedisMapState.html#updateStatesToRedis(java.util.Map)">updateStatesToRedis</a></code>&nbsp;in class&nbsp;<code><a href="AbstractRedisMapState.html" title="class in org.apache.storm.redis.trident.state">AbstractRedisMapState</a>&lt;<a href="RedisClusterMapState.html" title="type parameter in RedisClusterMapState">T</a>&gt;</code></dd>
<dt>Parameters:</dt>
<dd><code>keyValues</code> - (key, value) pairs</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>