| <!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>Plugin (Apache Beam 2.47.0)</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="Plugin (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":10,"i10":6,"i11":10,"i12":6,"i13":10,"i14":6,"i15":9,"i16":9,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/cdap/MappingUtils.html" title="class in org.apache.beam.sdk.io.cdap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.Builder.html" title="class in org.apache.beam.sdk.io.cdap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/cdap/Plugin.html" target="_top">Frames</a></li> |
| <li><a href="Plugin.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.cdap</div> |
| <h2 title="Class Plugin" class="title">Class Plugin<K,V></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.cdap.Plugin<K,V></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">Plugin<K,V></span> |
| extends java.lang.Object</pre> |
| <div class="block">Class wrapper for a CDAP plugin.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.Builder.html" title="class in org.apache.beam.sdk.io.cdap">Plugin.Builder</a><<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.Builder.html" title="type parameter in Plugin.Builder">K</a>,<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.Builder.html" title="type parameter in Plugin.Builder">V</a>></span></code> |
| <div class="block">Builder class for a <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap"><code>Plugin</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://static.javadoc.io/io.cdap.cdap/cdap-etl-api/6.5.1/io/cdap/cdap/etl/api/SubmitterLifecycle.html?is-external=true" title="class or interface in io.cdap.cdap.etl.api">SubmitterLifecycle</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#cdapPluginObj">cdapPluginObj</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.10.2/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#hadoopConfiguration">hadoopConfiguration</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/PluginConfig.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin">PluginConfig</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#pluginConfig">pluginConfig</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#Plugin--">Plugin</a></span>()</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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 <K,V> <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.Builder.html" title="class in org.apache.beam.sdk.io.cdap">Plugin.Builder</a><K,V></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#builder--">builder</a></span>()</code> |
| <div class="block">Creates a plugin builder instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <K,V> <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap">Plugin</a><K,V></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#createBatch-java.lang.Class-java.lang.Class-java.lang.Class-">createBatch</a></span>(java.lang.Class<?> newPluginClass, |
| java.lang.Class<?> newFormatClass, |
| java.lang.Class<?> newFormatProviderClass)</code> |
| <div class="block">Creates a batch plugin instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <K,V> <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap">Plugin</a><K,V></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#createStreaming-java.lang.Class-org.apache.beam.sdk.transforms.SerializableFunction-java.lang.Class-">createStreaming</a></span>(java.lang.Class<?> newPluginClass, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><V,java.lang.Long> getOffsetFn, |
| java.lang.Class<? extends org.apache.spark.streaming.receiver.Receiver<V>> receiverClass)</code> |
| <div class="block">Creates a streaming plugin instance with default function for getting args for <code>Receiver</code>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <K,V> <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap">Plugin</a><K,V></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#createStreaming-java.lang.Class-org.apache.beam.sdk.transforms.SerializableFunction-java.lang.Class-org.apache.beam.sdk.transforms.SerializableFunction-">createStreaming</a></span>(java.lang.Class<?> newPluginClass, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><V,java.lang.Long> getOffsetFn, |
| java.lang.Class<? extends org.apache.spark.streaming.receiver.Receiver<V>> receiverClass, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/PluginConfig.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin">PluginConfig</a>,java.lang.Object[]> getReceiverArgsFromConfigFn)</code> |
| <div class="block">Creates a streaming plugin instance.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/beam/sdk/io/cdap/context/BatchContextImpl.html" title="class in org.apache.beam.sdk.io.cdap.context">BatchContextImpl</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#getContext--">getContext</a></span>()</code> |
| <div class="block">Gets the context of a plugin.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract java.lang.Class<?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#getFormatClass--">getFormatClass</a></span>()</code> |
| <div class="block">Gets InputFormat or OutputFormat class for a plugin.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.Class<?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#getFormatProviderClass--">getFormatProviderClass</a></span>()</code> |
| <div class="block">Gets InputFormatProvider or OutputFormatProvider class for a plugin.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>,java.lang.Long></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#getGetOffsetFn--">getGetOffsetFn</a></span>()</code> |
| <div class="block">Gets a <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> that defines how to get record offset for CDAP <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap"><code>Plugin</code></a> class.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/PluginConfig.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin">PluginConfig</a>,java.lang.Object[]></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#getGetReceiverArgsFromConfigFn--">getGetReceiverArgsFromConfigFn</a></span>()</code> |
| <div class="block">Gets a <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> that defines how to get constructor arguments for <code>Receiver</code> using <a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/PluginConfig.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin"><code>PluginConfig</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.10.2/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#getHadoopConfiguration--">getHadoopConfiguration</a></span>()</code> |
| <div class="block">Gets a plugin Hadoop configuration.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.Class<?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#getPluginClass--">getPluginClass</a></span>()</code> |
| <div class="block">Gets the main class of a plugin.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/PluginConfig.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin">PluginConfig</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#getPluginConfig--">getPluginConfig</a></span>()</code> |
| <div class="block">Gets a plugin config.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/beam/sdk/io/cdap/PluginConstants.PluginType.html" title="enum in org.apache.beam.sdk.io.cdap">PluginConstants.PluginType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#getPluginType--">getPluginType</a></span>()</code> |
| <div class="block">Gets a plugin type.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/sparkreceiver/ReceiverBuilder.html" title="class in org.apache.beam.sdk.io.sparkreceiver">ReceiverBuilder</a><<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>,? extends org.apache.spark.streaming.receiver.Receiver<<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#getReceiverBuilder--">getReceiverBuilder</a></span>()</code> |
| <div class="block">Gets a <a href="../../../../../../org/apache/beam/sdk/io/sparkreceiver/ReceiverBuilder.html" title="class in org.apache.beam.sdk.io.sparkreceiver"><code>ReceiverBuilder</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.Class<? extends org.apache.spark.streaming.receiver.Receiver<<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#getReceiverClass--">getReceiverClass</a></span>()</code> |
| <div class="block">Gets Spark <code>Receiver</code> class for a CDAP plugin.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/cdap/context/BatchContextImpl.html" title="class in org.apache.beam.sdk.io.cdap.context">BatchContextImpl</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#initContext-java.lang.Class-">initContext</a></span>(java.lang.Class<?> cdapPluginClass)</code> |
| <div class="block">Initializes <a href="../../../../../../org/apache/beam/sdk/io/cdap/context/BatchContextImpl.html" title="class in org.apache.beam.sdk.io.cdap.context"><code>BatchContextImpl</code></a> for CDAP plugin.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/cdap/PluginConstants.PluginType.html" title="enum in org.apache.beam.sdk.io.cdap">PluginConstants.PluginType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#initPluginType-java.lang.Class-">initPluginType</a></span>(java.lang.Class<?> pluginClass)</code> |
| <div class="block">Gets value of a plugin type.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#isUnbounded--">isUnbounded</a></span>()</code> |
| <div class="block">Gets value of a plugin type.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#prepareRun--">prepareRun</a></span>()</code> |
| <div class="block">Calls <a href="https://static.javadoc.io/io.cdap.cdap/cdap-etl-api/6.5.1/io/cdap/cdap/etl/api/SubmitterLifecycle.html?is-external=true#prepareRun-T-" title="class or interface in io.cdap.cdap.etl.api"><code>SubmitterLifecycle.prepareRun(Object)</code></a> method on the <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#cdapPluginObj"><code>cdapPluginObj</code></a> |
| passing needed configuration object as a parameter.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap">Plugin</a><<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">K</a>,<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#withConfig-io.cdap.cdap.api.plugin.PluginConfig-">withConfig</a></span>(<a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/PluginConfig.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin">PluginConfig</a> pluginConfig)</code> |
| <div class="block">Sets a plugin config.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap">Plugin</a><<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">K</a>,<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#withHadoopConfiguration-java.lang.Class-java.lang.Class-">withHadoopConfiguration</a></span>(java.lang.Class<<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">K</a>> formatKeyClass, |
| java.lang.Class<<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>> formatValueClass)</code> |
| <div class="block">Sets a plugin Hadoop configuration.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap">Plugin</a><<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">K</a>,<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#withHadoopConfiguration-org.apache.hadoop.conf.Configuration-">withHadoopConfiguration</a></span>(<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.10.2/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> hadoopConfiguration)</code> |
| <div class="block">Sets a plugin Hadoop configuration.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="pluginConfig"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pluginConfig</h4> |
| <pre><a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| protected <a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/PluginConfig.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin">PluginConfig</a> pluginConfig</pre> |
| </li> |
| </ul> |
| <a name="hadoopConfiguration"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hadoopConfiguration</h4> |
| <pre><a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| protected <a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.10.2/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> hadoopConfiguration</pre> |
| </li> |
| </ul> |
| <a name="cdapPluginObj"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cdapPluginObj</h4> |
| <pre><a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| protected <a href="https://static.javadoc.io/io.cdap.cdap/cdap-etl-api/6.5.1/io/cdap/cdap/etl/api/SubmitterLifecycle.html?is-external=true" title="class or interface in io.cdap.cdap.etl.api">SubmitterLifecycle</a> cdapPluginObj</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Plugin--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Plugin</h4> |
| <pre>public Plugin()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContext</h4> |
| <pre>public abstract <a href="../../../../../../org/apache/beam/sdk/io/cdap/context/BatchContextImpl.html" title="class in org.apache.beam.sdk.io.cdap.context">BatchContextImpl</a> getContext()</pre> |
| <div class="block">Gets the context of a plugin.</div> |
| </li> |
| </ul> |
| <a name="getPluginClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPluginClass</h4> |
| <pre>public abstract java.lang.Class<?> getPluginClass()</pre> |
| <div class="block">Gets the main class of a plugin.</div> |
| </li> |
| </ul> |
| <a name="getFormatClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFormatClass</h4> |
| <pre><a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| public abstract java.lang.Class<?> getFormatClass()</pre> |
| <div class="block">Gets InputFormat or OutputFormat class for a plugin.</div> |
| </li> |
| </ul> |
| <a name="getFormatProviderClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFormatProviderClass</h4> |
| <pre><a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| public abstract java.lang.Class<?> getFormatProviderClass()</pre> |
| <div class="block">Gets InputFormatProvider or OutputFormatProvider class for a plugin.</div> |
| </li> |
| </ul> |
| <a name="getReceiverClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReceiverClass</h4> |
| <pre><a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| public abstract java.lang.Class<? extends org.apache.spark.streaming.receiver.Receiver<<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>>> getReceiverClass()</pre> |
| <div class="block">Gets Spark <code>Receiver</code> class for a CDAP plugin.</div> |
| </li> |
| </ul> |
| <a name="getGetOffsetFn--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGetOffsetFn</h4> |
| <pre><a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| public abstract <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>,java.lang.Long> getGetOffsetFn()</pre> |
| <div class="block">Gets a <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> that defines how to get record offset for CDAP <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap"><code>Plugin</code></a> class.</div> |
| </li> |
| </ul> |
| <a name="getGetReceiverArgsFromConfigFn--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGetReceiverArgsFromConfigFn</h4> |
| <pre><a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| public abstract <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/PluginConfig.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin">PluginConfig</a>,java.lang.Object[]> getGetReceiverArgsFromConfigFn()</pre> |
| <div class="block">Gets a <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> that defines how to get constructor arguments for <code>Receiver</code> using <a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/PluginConfig.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin"><code>PluginConfig</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withConfig-io.cdap.cdap.api.plugin.PluginConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withConfig</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap">Plugin</a><<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">K</a>,<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>> withConfig(<a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/PluginConfig.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin">PluginConfig</a> pluginConfig)</pre> |
| <div class="block">Sets a plugin config.</div> |
| </li> |
| </ul> |
| <a name="getPluginConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPluginConfig</h4> |
| <pre><a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| public <a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/PluginConfig.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin">PluginConfig</a> getPluginConfig()</pre> |
| <div class="block">Gets a plugin config.</div> |
| </li> |
| </ul> |
| <a name="prepareRun--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareRun</h4> |
| <pre>public void prepareRun()</pre> |
| <div class="block">Calls <a href="https://static.javadoc.io/io.cdap.cdap/cdap-etl-api/6.5.1/io/cdap/cdap/etl/api/SubmitterLifecycle.html?is-external=true#prepareRun-T-" title="class or interface in io.cdap.cdap.etl.api"><code>SubmitterLifecycle.prepareRun(Object)</code></a> method on the <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html#cdapPluginObj"><code>cdapPluginObj</code></a> |
| passing needed configuration object as a parameter. This method is needed for |
| validating connection to the CDAP sink/source and performing initial tuning.</div> |
| </li> |
| </ul> |
| <a name="withHadoopConfiguration-java.lang.Class-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withHadoopConfiguration</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap">Plugin</a><<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">K</a>,<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>> withHadoopConfiguration(java.lang.Class<<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">K</a>> formatKeyClass, |
| java.lang.Class<<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>> formatValueClass)</pre> |
| <div class="block">Sets a plugin Hadoop configuration.</div> |
| </li> |
| </ul> |
| <a name="withHadoopConfiguration-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withHadoopConfiguration</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap">Plugin</a><<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">K</a>,<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>> withHadoopConfiguration(<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.10.2/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> hadoopConfiguration)</pre> |
| <div class="block">Sets a plugin Hadoop configuration.</div> |
| </li> |
| </ul> |
| <a name="getHadoopConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHadoopConfiguration</h4> |
| <pre>public <a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.10.2/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> getHadoopConfiguration()</pre> |
| <div class="block">Gets a plugin Hadoop configuration.</div> |
| </li> |
| </ul> |
| <a name="getPluginType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPluginType</h4> |
| <pre>public abstract <a href="../../../../../../org/apache/beam/sdk/io/cdap/PluginConstants.PluginType.html" title="enum in org.apache.beam.sdk.io.cdap">PluginConstants.PluginType</a> getPluginType()</pre> |
| <div class="block">Gets a plugin type.</div> |
| </li> |
| </ul> |
| <a name="initPluginType-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initPluginType</h4> |
| <pre>public static <a href="../../../../../../org/apache/beam/sdk/io/cdap/PluginConstants.PluginType.html" title="enum in org.apache.beam.sdk.io.cdap">PluginConstants.PluginType</a> initPluginType(java.lang.Class<?> pluginClass) |
| throws java.lang.IllegalArgumentException</pre> |
| <div class="block">Gets value of a plugin type.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initContext-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initContext</h4> |
| <pre>public static <a href="../../../../../../org/apache/beam/sdk/io/cdap/context/BatchContextImpl.html" title="class in org.apache.beam.sdk.io.cdap.context">BatchContextImpl</a> initContext(java.lang.Class<?> cdapPluginClass)</pre> |
| <div class="block">Initializes <a href="../../../../../../org/apache/beam/sdk/io/cdap/context/BatchContextImpl.html" title="class in org.apache.beam.sdk.io.cdap.context"><code>BatchContextImpl</code></a> for CDAP plugin.</div> |
| </li> |
| </ul> |
| <a name="isUnbounded--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUnbounded</h4> |
| <pre>public java.lang.Boolean isUnbounded()</pre> |
| <div class="block">Gets value of a plugin type.</div> |
| </li> |
| </ul> |
| <a name="getReceiverBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReceiverBuilder</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/sparkreceiver/ReceiverBuilder.html" title="class in org.apache.beam.sdk.io.sparkreceiver">ReceiverBuilder</a><<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>,? extends org.apache.spark.streaming.receiver.Receiver<<a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="type parameter in Plugin">V</a>>> getReceiverBuilder()</pre> |
| <div class="block">Gets a <a href="../../../../../../org/apache/beam/sdk/io/sparkreceiver/ReceiverBuilder.html" title="class in org.apache.beam.sdk.io.sparkreceiver"><code>ReceiverBuilder</code></a>.</div> |
| </li> |
| </ul> |
| <a name="createBatch-java.lang.Class-java.lang.Class-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createBatch</h4> |
| <pre>public static <K,V> <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap">Plugin</a><K,V> createBatch(java.lang.Class<?> newPluginClass, |
| java.lang.Class<?> newFormatClass, |
| java.lang.Class<?> newFormatProviderClass)</pre> |
| <div class="block">Creates a batch plugin instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newPluginClass</code> - class of the CDAP plugin <a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/annotation/Plugin.html?is-external=true" title="class or interface in io.cdap.cdap.api.annotation"><code>Plugin</code></a>.</dd> |
| <dd><code>newFormatClass</code> - Hadoop Input or Output format class.</dd> |
| <dd><code>newFormatProviderClass</code> - Hadoop Input or Output format provider class.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createStreaming-java.lang.Class-org.apache.beam.sdk.transforms.SerializableFunction-java.lang.Class-org.apache.beam.sdk.transforms.SerializableFunction-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createStreaming</h4> |
| <pre>public static <K,V> <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap">Plugin</a><K,V> createStreaming(java.lang.Class<?> newPluginClass, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><V,java.lang.Long> getOffsetFn, |
| java.lang.Class<? extends org.apache.spark.streaming.receiver.Receiver<V>> receiverClass, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/PluginConfig.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin">PluginConfig</a>,java.lang.Object[]> getReceiverArgsFromConfigFn)</pre> |
| <div class="block">Creates a streaming plugin instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newPluginClass</code> - class of the CDAP plugin <a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/Plugin.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin"><code>Plugin</code></a>.</dd> |
| <dd><code>getOffsetFn</code> - <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> that defines how to get record offset for CDAP |
| <a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/annotation/Plugin.html?is-external=true" title="class or interface in io.cdap.cdap.api.annotation"><code>Plugin</code></a> class.</dd> |
| <dd><code>receiverClass</code> - Spark <code>Receiver</code> class for a CDAP plugin.</dd> |
| <dd><code>getReceiverArgsFromConfigFn</code> - <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> that defines how to get |
| constructor arguments for <code>Receiver</code> using <a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/PluginConfig.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin"><code>PluginConfig</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createStreaming-java.lang.Class-org.apache.beam.sdk.transforms.SerializableFunction-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createStreaming</h4> |
| <pre>public static <K,V> <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.html" title="class in org.apache.beam.sdk.io.cdap">Plugin</a><K,V> createStreaming(java.lang.Class<?> newPluginClass, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><V,java.lang.Long> getOffsetFn, |
| java.lang.Class<? extends org.apache.spark.streaming.receiver.Receiver<V>> receiverClass)</pre> |
| <div class="block">Creates a streaming plugin instance with default function for getting args for <code>Receiver</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newPluginClass</code> - class of the CDAP plugin <a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/plugin/Plugin.html?is-external=true" title="class or interface in io.cdap.cdap.api.plugin"><code>Plugin</code></a>.</dd> |
| <dd><code>getOffsetFn</code> - <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> that defines how to get record offset for CDAP |
| <a href="https://static.javadoc.io/io.cdap.cdap/cdap-api/6.5.1/io/cdap/cdap/api/annotation/Plugin.html?is-external=true" title="class or interface in io.cdap.cdap.api.annotation"><code>Plugin</code></a> class.</dd> |
| <dd><code>receiverClass</code> - Spark <code>Receiver</code> class for a CDAP plugin.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="builder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>builder</h4> |
| <pre>public static <K,V> <a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.Builder.html" title="class in org.apache.beam.sdk.io.cdap">Plugin.Builder</a><K,V> builder()</pre> |
| <div class="block">Creates a plugin builder instance.</div> |
| </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/cdap/MappingUtils.html" title="class in org.apache.beam.sdk.io.cdap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/cdap/Plugin.Builder.html" title="class in org.apache.beam.sdk.io.cdap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/cdap/Plugin.html" target="_top">Frames</a></li> |
| <li><a href="Plugin.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
