blob: 001fda48292945a85ffaabff82823ffb9bcc4c95 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RedisIO.Write.Method (Apache Beam 2.38.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RedisIO.Write.Method (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<ul class="navList">
<li><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.html" title="class in org.apache.beam.sdk.io.redis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.WriteStreams.html" title="class in org.apache.beam.sdk.io.redis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" target="_top">Frames</a></li>
<li><a href="RedisIO.Write.Method.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.beam.sdk.io.redis</div>
<h2 title="Enum RedisIO.Write.Method" class="title">Enum RedisIO.Write.Method</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.io.redis.RedisIO.Write.Method</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a>&gt;</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.Write</a></dd>
</dl>
<hr>
<br>
<pre>public static enum <span class="typeNameLabel">RedisIO.Write.Method</span>
extends java.lang.Enum&lt;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a>&gt;</pre>
<div class="block">Determines the method used to insert data in Redis.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum.constant.summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Enum Constant and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html#APPEND">APPEND</a></span></code>
<div class="block">Use APPEND command.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html#DECRBY">DECRBY</a></span></code>
<div class="block">Use DECRBY command.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html#INCRBY">INCRBY</a></span></code>
<div class="block">Use INCBY command.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html#LPUSH">LPUSH</a></span></code>
<div class="block">Use LPUSH command.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html#PFADD">PFADD</a></span></code>
<div class="block">Use PFADD command.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html#RPUSH">RPUSH</a></span></code>
<div class="block">Use RPUSH command.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html#SADD">SADD</a></span></code>
<div class="block">Use SADD command.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html#SET">SET</a></span></code>
<div class="block">Use SET command.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html#values--">values</a></span>()</code>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum.constant.detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a name="APPEND">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>APPEND</h4>
<pre>public static final&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a> APPEND</pre>
<div class="block">Use APPEND command. If key already exists and is a string, this command appends the value
at the end of the string.</div>
</li>
</ul>
<a name="SET">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SET</h4>
<pre>public static final&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a> SET</pre>
<div class="block">Use SET command. If key already holds a value, it is overwritten.</div>
</li>
</ul>
<a name="LPUSH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LPUSH</h4>
<pre>public static final&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a> LPUSH</pre>
<div class="block">Use LPUSH command. Insert value at the head of the list stored at key. If key does not
exist, it is created as empty list before performing the push operations. When key holds a
value that is not a list, an error is returned.</div>
</li>
</ul>
<a name="RPUSH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RPUSH</h4>
<pre>public static final&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a> RPUSH</pre>
<div class="block">Use RPUSH command. Insert value at the tail of the list stored at key. If key does not
exist, it is created as empty list before performing the push operations. When key holds a
value that is not a list, an error is returned.</div>
</li>
</ul>
<a name="SADD">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SADD</h4>
<pre>public static final&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a> SADD</pre>
<div class="block">Use SADD command. Insert value in a set. Duplicated values are ignored.</div>
</li>
</ul>
<a name="PFADD">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PFADD</h4>
<pre>public static final&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a> PFADD</pre>
<div class="block">Use PFADD command. Insert value in a HLL structure. Create key if it doesn't exist</div>
</li>
</ul>
<a name="INCRBY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INCRBY</h4>
<pre>public static final&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a> INCRBY</pre>
<div class="block">Use INCBY command. Increment counter value of a key by a given value.</div>
</li>
</ul>
<a name="DECRBY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DECRBY</h4>
<pre>public static final&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a> DECRBY</pre>
<div class="block">Use DECRBY command. Decrement counter value of a key by given value.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="values--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a>[]&nbsp;values()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (RedisIO.Write.Method c : RedisIO.Write.Method.values())
&nbsp; System.out.println(c);
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a name="valueOf-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" title="enum in org.apache.beam.sdk.io.redis">RedisIO.Write.Method</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<ul class="navList">
<li><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.html" title="class in org.apache.beam.sdk.io.redis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.WriteStreams.html" title="class in org.apache.beam.sdk.io.redis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/redis/RedisIO.Write.Method.html" target="_top">Frames</a></li>
<li><a href="RedisIO.Write.Method.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>