Skip to content

Commit f568d7e

Browse files
author
Nathan Marz
committed
updated 'doc' to 0.7.1
1 parent e5dbebc commit f568d7e

File tree

249 files changed

+31975
-2733
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

249 files changed

+31975
-2733
lines changed

doc/allclasses-frame.html

Lines changed: 139 additions & 9 deletions
Large diffs are not rendered by default.

doc/allclasses-noframe.html

Lines changed: 139 additions & 9 deletions
Large diffs are not rendered by default.

doc/backtype/storm/Config.html

Lines changed: 169 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
<!--NewPage-->
33
<HTML>
44
<HEAD>
5-
<!-- Generated by javadoc (build 1.6.0_26) on Sat Jan 28 22:43:29 PST 2012 -->
5+
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:05 PDT 2012 -->
66
<TITLE>
77
Config
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2012-01-28">
10+
<META NAME="date" CONTENT="2012-04-02">
1111

1212
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
1313

@@ -322,6 +322,22 @@ <H2>
322322
<TR BGCOLOR="white" CLASS="TableRowColor">
323323
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
324324
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
325+
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#STORM_ZOOKEEPER_RETRY_INTERVAL">STORM_ZOOKEEPER_RETRY_INTERVAL</A></B></CODE>
326+
327+
<BR>
328+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The interval between retries of a Zookeeper operation.</TD>
329+
</TR>
330+
<TR BGCOLOR="white" CLASS="TableRowColor">
331+
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
332+
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
333+
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#STORM_ZOOKEEPER_RETRY_TIMES">STORM_ZOOKEEPER_RETRY_TIMES</A></B></CODE>
334+
335+
<BR>
336+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The number of times to retry a Zookeeper operation.</TD>
337+
</TR>
338+
<TR BGCOLOR="white" CLASS="TableRowColor">
339+
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
340+
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
325341
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#STORM_ZOOKEEPER_ROOT">STORM_ZOOKEEPER_ROOT</A></B></CODE>
326342

327343
<BR>
@@ -431,6 +447,14 @@ <H2>
431447
<TR BGCOLOR="white" CLASS="TableRowColor">
432448
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
433449
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
450+
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#TOPOLOGY_AUTO_TASK_HOOKS">TOPOLOGY_AUTO_TASK_HOOKS</A></B></CODE>
451+
452+
<BR>
453+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A list of task hooks that are automatically added to every spout and bolt in the topology.</TD>
454+
</TR>
455+
<TR BGCOLOR="white" CLASS="TableRowColor">
456+
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
457+
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
434458
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#TOPOLOGY_DEBUG">TOPOLOGY_DEBUG</A></B></CODE>
435459

436460
<BR>
@@ -481,6 +505,14 @@ <H2>
481505
<TR BGCOLOR="white" CLASS="TableRowColor">
482506
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
483507
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
508+
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#TOPOLOGY_NAME">TOPOLOGY_NAME</A></B></CODE>
509+
510+
<BR>
511+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of the topology.</TD>
512+
</TR>
513+
<TR BGCOLOR="white" CLASS="TableRowColor">
514+
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
515+
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
484516
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#TOPOLOGY_OPTIMIZE">TOPOLOGY_OPTIMIZE</A></B></CODE>
485517

486518
<BR>
@@ -516,6 +548,15 @@ <H2>
516548
<TR BGCOLOR="white" CLASS="TableRowColor">
517549
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
518550
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
551+
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#TOPOLOGY_TRANSACTIONAL_ID">TOPOLOGY_TRANSACTIONAL_ID</A></B></CODE>
552+
553+
<BR>
554+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This config is available for TransactionalSpouts, and contains the id ( a String) for
555+
the transactional topology.</TD>
556+
</TR>
557+
<TR BGCOLOR="white" CLASS="TableRowColor">
558+
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
559+
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
519560
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#TOPOLOGY_WORKER_CHILDOPTS">TOPOLOGY_WORKER_CHILDOPTS</A></B></CODE>
520561

521562
<BR>
@@ -533,6 +574,30 @@ <H2>
533574
<TR BGCOLOR="white" CLASS="TableRowColor">
534575
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
535576
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
577+
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#TRANSACTIONAL_ZOOKEEPER_PORT">TRANSACTIONAL_ZOOKEEPER_PORT</A></B></CODE>
578+
579+
<BR>
580+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The port to use to connect to the transactional zookeeper servers.</TD>
581+
</TR>
582+
<TR BGCOLOR="white" CLASS="TableRowColor">
583+
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
584+
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
585+
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#TRANSACTIONAL_ZOOKEEPER_ROOT">TRANSACTIONAL_ZOOKEEPER_ROOT</A></B></CODE>
586+
587+
<BR>
588+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The root directory in ZooKeeper for metadata about TransactionalSpouts.</TD>
589+
</TR>
590+
<TR BGCOLOR="white" CLASS="TableRowColor">
591+
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
592+
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
593+
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#TRANSACTIONAL_ZOOKEEPER_SERVERS">TRANSACTIONAL_ZOOKEEPER_SERVERS</A></B></CODE>
594+
595+
<BR>
596+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The list of zookeeper servers in which to keep the transactional state.</TD>
597+
</TR>
598+
<TR BGCOLOR="white" CLASS="TableRowColor">
599+
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
600+
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
536601
<TD><CODE><B><A HREF="../../backtype/storm/Config.html#UI_CHILDOPTS">UI_CHILDOPTS</A></B></CODE>
537602

538603
<BR>
@@ -843,6 +908,30 @@ <H2>
843908
</DL>
844909
<HR>
845910

911+
<A NAME="STORM_ZOOKEEPER_RETRY_TIMES"><!-- --></A><H3>
912+
STORM_ZOOKEEPER_RETRY_TIMES</H3>
913+
<PRE>
914+
public static java.lang.String <B>STORM_ZOOKEEPER_RETRY_TIMES</B></PRE>
915+
<DL>
916+
<DD>The number of times to retry a Zookeeper operation.
917+
<P>
918+
<DL>
919+
</DL>
920+
</DL>
921+
<HR>
922+
923+
<A NAME="STORM_ZOOKEEPER_RETRY_INTERVAL"><!-- --></A><H3>
924+
STORM_ZOOKEEPER_RETRY_INTERVAL</H3>
925+
<PRE>
926+
public static java.lang.String <B>STORM_ZOOKEEPER_RETRY_INTERVAL</B></PRE>
927+
<DL>
928+
<DD>The interval between retries of a Zookeeper operation.
929+
<P>
930+
<DL>
931+
</DL>
932+
</DL>
933+
<HR>
934+
846935
<A NAME="STORM_ID"><!-- --></A><H3>
847936
STORM_ID</H3>
848937
<PRE>
@@ -1403,6 +1492,84 @@ <H2>
14031492
</DL>
14041493
<HR>
14051494

1495+
<A NAME="TOPOLOGY_TRANSACTIONAL_ID"><!-- --></A><H3>
1496+
TOPOLOGY_TRANSACTIONAL_ID</H3>
1497+
<PRE>
1498+
public static java.lang.String <B>TOPOLOGY_TRANSACTIONAL_ID</B></PRE>
1499+
<DL>
1500+
<DD>This config is available for TransactionalSpouts, and contains the id ( a String) for
1501+
the transactional topology. This id is used to store the state of the transactional
1502+
topology in Zookeeper.
1503+
<P>
1504+
<DL>
1505+
</DL>
1506+
</DL>
1507+
<HR>
1508+
1509+
<A NAME="TOPOLOGY_AUTO_TASK_HOOKS"><!-- --></A><H3>
1510+
TOPOLOGY_AUTO_TASK_HOOKS</H3>
1511+
<PRE>
1512+
public static java.lang.String <B>TOPOLOGY_AUTO_TASK_HOOKS</B></PRE>
1513+
<DL>
1514+
<DD>A list of task hooks that are automatically added to every spout and bolt in the topology. An example
1515+
of when you'd do this is to add a hook that integrates with your internal
1516+
monitoring system. These hooks are instantiated using the zero-arg constructor.
1517+
<P>
1518+
<DL>
1519+
</DL>
1520+
</DL>
1521+
<HR>
1522+
1523+
<A NAME="TOPOLOGY_NAME"><!-- --></A><H3>
1524+
TOPOLOGY_NAME</H3>
1525+
<PRE>
1526+
public static java.lang.String <B>TOPOLOGY_NAME</B></PRE>
1527+
<DL>
1528+
<DD>Name of the topology. This config is automatically set by Storm when the topology is submitted.
1529+
<P>
1530+
<DL>
1531+
</DL>
1532+
</DL>
1533+
<HR>
1534+
1535+
<A NAME="TRANSACTIONAL_ZOOKEEPER_ROOT"><!-- --></A><H3>
1536+
TRANSACTIONAL_ZOOKEEPER_ROOT</H3>
1537+
<PRE>
1538+
public static java.lang.String <B>TRANSACTIONAL_ZOOKEEPER_ROOT</B></PRE>
1539+
<DL>
1540+
<DD>The root directory in ZooKeeper for metadata about TransactionalSpouts.
1541+
<P>
1542+
<DL>
1543+
</DL>
1544+
</DL>
1545+
<HR>
1546+
1547+
<A NAME="TRANSACTIONAL_ZOOKEEPER_SERVERS"><!-- --></A><H3>
1548+
TRANSACTIONAL_ZOOKEEPER_SERVERS</H3>
1549+
<PRE>
1550+
public static java.lang.String <B>TRANSACTIONAL_ZOOKEEPER_SERVERS</B></PRE>
1551+
<DL>
1552+
<DD>The list of zookeeper servers in which to keep the transactional state. If null (which is default),
1553+
will use storm.zookeeper.servers
1554+
<P>
1555+
<DL>
1556+
</DL>
1557+
</DL>
1558+
<HR>
1559+
1560+
<A NAME="TRANSACTIONAL_ZOOKEEPER_PORT"><!-- --></A><H3>
1561+
TRANSACTIONAL_ZOOKEEPER_PORT</H3>
1562+
<PRE>
1563+
public static java.lang.String <B>TRANSACTIONAL_ZOOKEEPER_PORT</B></PRE>
1564+
<DL>
1565+
<DD>The port to use to connect to the transactional zookeeper servers. If null (which is default),
1566+
will use storm.zookeeper.port
1567+
<P>
1568+
<DL>
1569+
</DL>
1570+
</DL>
1571+
<HR>
1572+
14061573
<A NAME="ZMQ_THREADS"><!-- --></A><H3>
14071574
ZMQ_THREADS</H3>
14081575
<PRE>

doc/backtype/storm/Constants.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
<!--NewPage-->
33
<HTML>
44
<HEAD>
5-
<!-- Generated by javadoc (build 1.6.0_26) on Sat Jan 28 22:43:29 PST 2012 -->
5+
<!-- Generated by javadoc (build 1.6.0_29) on Mon Apr 02 13:14:05 PDT 2012 -->
66
<TITLE>
77
Constants
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2012-01-28">
10+
<META NAME="date" CONTENT="2012-04-02">
1111

1212
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
1313

0 commit comments

Comments
 (0)