| <!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 (1.8.0_152) on Mon Apr 02 22:52:27 UTC 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RequestBuilder (streams-provider-sysomos 0.5.2-SNAPSHOT API)</title> |
| <meta name="date" content="2018-04-02"> |
| <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="RequestBuilder (streams-provider-sysomos 0.5.2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/RequestBuilder.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/streams/sysomos/provider/ContentRequestBuilder.html" title="class in org.apache.streams.sysomos.provider"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/streams/sysomos/provider/SysomosClient.html" title="class in org.apache.streams.sysomos.provider"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/streams/sysomos/provider/RequestBuilder.html" target="_top">Frames</a></li> |
| <li><a href="RequestBuilder.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.streams.sysomos.provider</div> |
| <h2 title="Interface RequestBuilder" class="title">Interface RequestBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/streams/sysomos/provider/AbstractRequestBuilder.html" title="class in org.apache.streams.sysomos.provider">AbstractRequestBuilder</a>, <a href="../../../../../org/apache/streams/sysomos/provider/ContentRequestBuilder.html" title="class in org.apache.streams.sysomos.provider">ContentRequestBuilder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RequestBuilder</span></pre> |
| <div class="block">Simplifying abstraction that aids in building a request to the Sysomos API in a chained fashion.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="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></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><a href="../../../../../com/sysomos/xml/BeatApi.BeatResponse.html" title="class in com.sysomos.xml">BeatApi.BeatResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#execute--">execute</a></span>()</code> |
| <div class="block">Executes the request to the Sysomos Heartbeat API and returns a valid response</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#getRequestUrl--">getRequestUrl</a></span>()</code> |
| <div class="block">Returns the full url need to execute a request.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setAddedAfterDate-org.joda.time.DateTime-">setAddedAfterDate</a></span>(org.joda.time.DateTime afterDate)</code> |
| <div class="block">Sets the date after which documents should be returned from Sysomos.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setAddedBeforeDate-org.joda.time.DateTime-">setAddedBeforeDate</a></span>(org.joda.time.DateTime beforeDate)</code> |
| <div class="block">Sets the date before which documents should be returned from Sysomos.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setHeartBeatId-int-">setHeartBeatId</a></span>(int hid)</code> |
| <div class="block">Sets the Sysomos Heartbeat ID.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setHeartBeatId-java.lang.String-">setHeartBeatId</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hid)</code> |
| <div class="block">Sets the Sysomos Heartbeat ID as a String.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setOffset-long-">setOffset</a></span>(long offset)</code> |
| <div class="block">Sets the starting offset for the number of documents given the other parameters.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setReturnSetSize-long-">setReturnSetSize</a></span>(long size)</code> |
| <div class="block">Sets the size of the expected response.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setAddedAfterDate-org.joda.time.DateTime-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAddedAfterDate</h4> |
| <pre><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a> setAddedAfterDate(org.joda.time.DateTime afterDate)</pre> |
| <div class="block">Sets the date after which documents should be returned from Sysomos.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>afterDate</code> - the <code>DateTime</code> instance representing the after date</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The RequestBuilder for continued Chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAddedBeforeDate-org.joda.time.DateTime-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAddedBeforeDate</h4> |
| <pre><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a> setAddedBeforeDate(org.joda.time.DateTime beforeDate)</pre> |
| <div class="block">Sets the date before which documents should be returned from Sysomos.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>beforeDate</code> - the <code>DateTime</code> instance representing the before date</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The RequestBuilder for continued Chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReturnSetSize-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReturnSetSize</h4> |
| <pre><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a> setReturnSetSize(long size)</pre> |
| <div class="block">Sets the size of the expected response.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>size</code> - the number of documents</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The RequestBuilder for continued Chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOffset-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOffset</h4> |
| <pre><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a> setOffset(long offset)</pre> |
| <div class="block">Sets the starting offset for the number of documents given the other parameters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>offset</code> - the starting offset</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The RequestBuilder for continued Chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHeartBeatId-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHeartBeatId</h4> |
| <pre><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a> setHeartBeatId(int hid)</pre> |
| <div class="block">Sets the Sysomos Heartbeat ID.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hid</code> - Heartbeat ID</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The RequestBuilder for continued Chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHeartBeatId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHeartBeatId</h4> |
| <pre><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a> setHeartBeatId(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hid)</pre> |
| <div class="block">Sets the Sysomos Heartbeat ID as a String.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hid</code> - Heartbeat ID string</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The RequestBuilder for continued Chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRequestUrl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequestUrl</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> getRequestUrl()</pre> |
| <div class="block">Returns the full url need to execute a request. |
| |
| <p/> |
| Example: |
| http://api.sysomos.com/dev/v1/heartbeat/content?apiKey=YOUR |
| -APIKEY&hid=YOUR-HEARTBEAT-ID&offset=0&size=10& |
| addedAfter=2010-10-15T13:00:00Z&addedBefore=2010-10-18T13:00:00Z</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the URL to use when making requests of Sysomos Heartbeat</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre><a href="../../../../../com/sysomos/xml/BeatApi.BeatResponse.html" title="class in com.sysomos.xml">BeatApi.BeatResponse</a> execute()</pre> |
| <div class="block">Executes the request to the Sysomos Heartbeat API and returns a valid response</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="class-use/RequestBuilder.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/streams/sysomos/provider/ContentRequestBuilder.html" title="class in org.apache.streams.sysomos.provider"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/streams/sysomos/provider/SysomosClient.html" title="class in org.apache.streams.sysomos.provider"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/streams/sysomos/provider/RequestBuilder.html" target="_top">Frames</a></li> |
| <li><a href="RequestBuilder.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
