Skip to content

Commit

Permalink
Release 25.306.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@apamabld
apamabld committed Nov 6, 2024
1 parent 628c04d commit 597c0b8
Show file tree
Hide file tree
Showing 11 changed files with 16 additions and 36 deletions.
Binary file modified block-api/framework/analyticsbuilder-framework.cdp
View file
Binary file not shown.
Binary file modified block-api/framework/cumulocity-inventoryLookup-events.cdp
View file
Binary file not shown.
1 change: 0 additions & 1 deletion doc/apamadoc/alltypes-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
<A target="typeFrame" title="type in apama.analyticsbuilder" HREF="apama/analyticsbuilder/ActivateModel.html">ActivateModel</A><BR>
<A target="typeFrame" title="type in apama.analyticsbuilder" HREF="apama/analyticsbuilder/Activation.html">Activation</A><BR>
<A target="typeFrame" title="type in apama.analyticsbuilder" HREF="apama/analyticsbuilder/BlockBase.html">BlockBase</A><BR>
<A target="typeFrame" title="type in apama.analyticsbuilder.cumulocity" HREF="apama/analyticsbuilder/cumulocity/BlockBaseValidator.html">BlockBaseValidator</A><BR>
<A target="typeFrame" title="type in apama.analyticsbuilder" HREF="apama/analyticsbuilder/ConfigurationProperty.html">ConfigurationProperty</A><BR>
<A target="typeFrame" title="type in apama.analyticsbuilder.cumulocity" HREF="apama/analyticsbuilder/cumulocity/CumulocityInputHandler.html">CumulocityInputHandler</A><BR>
<A target="typeFrame" title="type in apama.analyticsbuilder.cumulocity" HREF="apama/analyticsbuilder/cumulocity/CumulocityInputParams.html">CumulocityInputParams</A><BR>
Expand Down
1 change: 0 additions & 1 deletion doc/apamadoc/alltypes-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
<A title="type in apama.analyticsbuilder" HREF="apama/analyticsbuilder/ActivateModel.html">ActivateModel</A><BR>
<A title="type in apama.analyticsbuilder" HREF="apama/analyticsbuilder/Activation.html">Activation</A><BR>
<A title="type in apama.analyticsbuilder" HREF="apama/analyticsbuilder/BlockBase.html">BlockBase</A><BR>
<A title="type in apama.analyticsbuilder.cumulocity" HREF="apama/analyticsbuilder/cumulocity/BlockBaseValidator.html">BlockBaseValidator</A><BR>
<A title="type in apama.analyticsbuilder" HREF="apama/analyticsbuilder/ConfigurationProperty.html">ConfigurationProperty</A><BR>
<A title="type in apama.analyticsbuilder.cumulocity" HREF="apama/analyticsbuilder/cumulocity/CumulocityInputHandler.html">CumulocityInputHandler</A><BR>
<A title="type in apama.analyticsbuilder.cumulocity" HREF="apama/analyticsbuilder/cumulocity/CumulocityInputParams.html">CumulocityInputParams</A><BR>
Expand Down
4 changes: 2 additions & 2 deletions doc/apamadoc/apama/analyticsbuilder/BlockBase.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
<TR><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>&nbsp;float</CODE></FONT></TD><TD><CODE></CODE><CODE><B><A HREF="BlockBase.html#getModelTime()">getModelTime</A></B>()</CODE><br>
<br>The current effective model time. This should be used instead of <tt>currentTime</tt> when access to the current time is required. The time for any absolute timer must be greater than this value.<DL><DT><B>Deprecated:</B></DT><DD><I>This action has been deprecated. Use the <tt>timestamp</tt> field of the <tt>Activation</tt> event to get the current model time.</I></DD></DL></TD></TR>
<TR><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>&nbsp;com.apama.cumulocity.TenantDetails</CODE></FONT></TD><TD><CODE></CODE><CODE><B><A HREF="BlockBase.html#getTenantDetails()">getTenantDetails</A></B>()</CODE><br>
<br>get the current tenant details.</TD></TR>
<br>Get the current tenant details.</TD></TR>
<TR><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>&nbsp;<A HREF="../../apama/analyticsbuilder/OutputHandler.html" title="type in apama.analyticsbuilder">apama.analyticsbuilder.OutputHandler</A></CODE></FONT></TD><TD><CODE></CODE><CODE><B><A HREF="BlockBase.html#producesOutput()">producesOutput</A></B>(<A HREF="../../apama/analyticsbuilder/OutputParams.html" title="type in apama.analyticsbuilder">apama.analyticsbuilder.OutputParams</A>&nbsp;outputParams)</CODE><br>
<br>Declare this block is an output block that produces events described by the <tt>outputParams</tt> parameter.</TD></TR>
<TR><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>&nbsp;void</CODE></FONT></TD><TD><CODE></CODE><CODE><B><A HREF="BlockBase.html#profile()">profile</A></B>(integer&nbsp;type)</CODE><br>
Expand Down Expand Up @@ -82,7 +82,7 @@
<A NAME="getModelTime()"></A><H3>getModelTime</H3><PRE>float&nbsp;<B>getModelTime</B>()</PRE><DL><DT><B>Deprecated:</B></DT><DD><I>This action has been deprecated. Use the <tt>timestamp</tt> field of the <tt>Activation</tt> event to get the current model time.</I></DD></DL>
The current effective model time. This should be used instead of <tt>currentTime</tt> when access to the current time is required. The time for any absolute timer must be greater than this value.<DL><DT><B>See Also:</B></DT><DD><A HREF="../../apama/analyticsbuilder/Activation.html#timestamp" title="Member of apama.analyticsbuilder.">apama.analyticsbuilder.Activation.timestamp</A>&nbsp;-&nbsp;to get the current model time.</DD></DL><HR>
<A NAME="getTenantDetails()"></A><H3>getTenantDetails</H3><PRE>com.apama.cumulocity.TenantDetails&nbsp;<B>getTenantDetails</B>()</PRE>
get the current tenant details.<HR>
Get the current tenant details.<HR>
<A NAME="producesOutput()"></A><H3>producesOutput</H3><PRE><A HREF="../../apama/analyticsbuilder/OutputHandler.html" title="type in apama.analyticsbuilder">apama.analyticsbuilder.OutputHandler</A>&nbsp;<B>producesOutput</B>(<A HREF="../../apama/analyticsbuilder/OutputParams.html" title="type in apama.analyticsbuilder">apama.analyticsbuilder.OutputParams</A>&nbsp;outputParams)</PRE>
Declare this block is an output block that produces events described by the <tt>outputParams</tt> parameter.<br><br> An output block sends events to outside the model, potentially to other models. This must be called during <tt>$validate</tt>, not afterward.<DL><DT><B>Parameters:</B></DT><DD><tt>outputParams</tt>&nbsp;-&nbsp;The parameters describing an output event stream.</DD></DL><DL><DT><B>Returns:</B></DT><DD>The output handler that should be used for sending output events.</DD></DL><HR>
<A NAME="profile()"></A><H3>profile</H3><PRE>void&nbsp;<B>profile</B>(integer&nbsp;type)</PRE>
Expand Down
20 changes: 0 additions & 20 deletions doc/apamadoc/apama/analyticsbuilder/cumulocity/BlockBaseValidator.html
View file

This file was deleted.

8 changes: 4 additions & 4 deletions doc/apamadoc/apama/analyticsbuilder/cumulocity/inventory/InventoryLookup.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@
</TD><TD CLASS="NavBarCell1"><A HREF="../../../..//apama/analyticsbuilder/cumulocity/inventory/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A></TD><TD CLASS="NavBarCell1"><A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;
</TD><TD CLASS="NavBarCell1"><A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT>&nbsp;
</A></TD><TD CLASS="NavBarCell1" WIDTH="100%" ALIGN="RIGHT"><FONT CLASS="NavBarFont1"><B>Apama Analytics Builder</B></FONT></TD></TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN="3"><EM></EM></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">SUMMARY:&nbsp;IMPORT&nbsp;|&nbsp;CONSTANT&nbsp;|&nbsp;<A HREF="#member_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#action_summary">ACTION</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL:&nbsp;IMPORT&nbsp;|&nbsp;CONSTANT&nbsp;|&nbsp;<A HREF="#member_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#action_detail">ACTION</A></FONT></TD></TR></TABLE><HR><H2><FONT SIZE="-1">apama.analyticsbuilder.cumulocity.inventory</FONT><BR>Event InventoryLookup</H2><HR>
An API for looking up groups and devices in the inventory.<br><br> This is typically used as so: <pre><br> InventoryLookup.lookup(<tt>deviceId</tt>, <tt>currentTenant</tt>).andThen(callback);<br> <br> action callback(any lookupResult){<br> InventoryLookupResult lookupResult := <tt> &lt InventoryLookupResult &gt </tt>lookupResult;<br> }<br></pre><DL><DT><B>See Also:</B></DT><DD><A HREF="../../../../apama/analyticsbuilder/cumulocity/inventory/InventoryLookupResult.html" title="type in apama.analyticsbuilder.cumulocity.inventory">apama.analyticsbuilder.cumulocity.inventory.InventoryLookupResult</A>&nbsp;-&nbsp;for more details.</DD></DL><HR><A NAME="member_summary"></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Field summary</B></FONT></TH></TR><TR><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>&nbsp;com.apama.cumulocity.TenantDetails</CODE></FONT></TD><TD><CODE><B><A HREF="InventoryLookup.html#tenant">tenant</A></B></CODE><br>
An API for looking up groups and devices in the inventory.<br><br> This is typically used as so: <pre><br> InventoryLookup.lookup(<tt>deviceId</tt>).andThen(callback);<br> <br> action callback(any lookupResult){<br> InventoryLookupResult lookupResult := <tt> &lt InventoryLookupResult &gt </tt>lookupResult;<br> }<br></pre><DL><DT><B>See Also:</B></DT><DD><A HREF="../../../../apama/analyticsbuilder/cumulocity/inventory/InventoryLookupResult.html" title="type in apama.analyticsbuilder.cumulocity.inventory">apama.analyticsbuilder.cumulocity.inventory.InventoryLookupResult</A>&nbsp;-&nbsp;for more details.</DD></DL><HR><A NAME="member_summary"></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Field summary</B></FONT></TH></TR><TR><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>&nbsp;com.apama.cumulocity.TenantDetails</CODE></FONT></TD><TD><CODE><B><A HREF="InventoryLookup.html#tenant">tenant</A></B></CODE><br>
<br>current tenant .</TD></TR></TABLE>&nbsp;<A NAME="action_summary"></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Action summary</B></FONT></TH></TR>
<TR><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>&nbsp;<A HREF="../../../../apama/analyticsbuilder/Promise.html" title="type in apama.analyticsbuilder">apama.analyticsbuilder.Promise</A></CODE></FONT></TD><TD><CODE>static </CODE><CODE><B><A HREF="InventoryLookup.html#lookup()">lookup</A></B>(any&nbsp;deviceId,&nbsp;com.apama.cumulocity.TenantDetails&nbsp;currentTenant)</CODE><br>
<TR><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>&nbsp;<A HREF="../../../../apama/analyticsbuilder/Promise.html" title="type in apama.analyticsbuilder">apama.analyticsbuilder.Promise</A></CODE></FONT></TD><TD><CODE>static </CODE><CODE><B><A HREF="InventoryLookup.html#lookup()">lookup</A></B>(any&nbsp;deviceId)</CODE><br>
<br>Inventory lookup for the device.</TD></TR></TABLE>&nbsp;<A NAME="member_detail"></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR><TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"><B>Field detail</B></FONT></TH></TR></TABLE>
<A NAME="tenant"></A><H3>tenant</H3><PRE>com.apama.cumulocity.TenantDetails&nbsp;<B>tenant</B></PRE>
current tenant .<HR><A NAME="action_detail"></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR><TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"><B>Action detail</B></FONT></TH></TR></TABLE>
<A NAME="lookup()"></A><H3>lookup</H3><PRE><A HREF="../../../../apama/analyticsbuilder/Promise.html" title="type in apama.analyticsbuilder">apama.analyticsbuilder.Promise</A>&nbsp;static <B>lookup</B>(any&nbsp;deviceId,&nbsp;com.apama.cumulocity.TenantDetails&nbsp;currentTenant)</PRE>
Inventory lookup for the device.<DL><DT><B>Parameters:</B></DT><DD><tt>deviceId</tt>&nbsp;-&nbsp;The device or group identifier.</DD><DD><tt>currentTenant</tt></DD></DL><DL><DT><B>Returns:</B></DT><DD>A <tt>Promise</tt> lookup result, which could be an <tt>InventoryLookupResult</tt></DD></DL><DL><DT><B>See Also:</B></DT><DD>InventoryLookupResult()&nbsp;-&nbsp;see this event for more details.</DD></DL><HR><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="" CLASS="NavBar"><TR><TD CLASS="NavBarCell2"><FONT SIZE="-2"><A target="_top" HREF="../../../../index.html?apama/analyticsbuilder/cumulocity/inventory/InventoryLookup.html"><B>FRAMES</B></A> &nbsp;
<A NAME="lookup()"></A><H3>lookup</H3><PRE><A HREF="../../../../apama/analyticsbuilder/Promise.html" title="type in apama.analyticsbuilder">apama.analyticsbuilder.Promise</A>&nbsp;static <B>lookup</B>(any&nbsp;deviceId)</PRE>
Inventory lookup for the device.<DL><DT><B>Parameters:</B></DT><DD><tt>deviceId</tt>&nbsp;-&nbsp;The device or group identifier.</DD></DL><DL><DT><B>Returns:</B></DT><DD>A <tt>Promise</tt> lookup result, which could be an <tt>InventoryLookupResult</tt></DD></DL><DL><DT><B>See Also:</B></DT><DD>InventoryLookupResult()&nbsp;-&nbsp;see this event for more details.</DD></DL><HR><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="" CLASS="NavBar"><TR><TD CLASS="NavBarCell2"><FONT SIZE="-2"><A target="_top" HREF="../../../../index.html?apama/analyticsbuilder/cumulocity/inventory/InventoryLookup.html"><B>FRAMES</B></A> &nbsp;

&nbsp;<A target="_top" HREF="InventoryLookup.html"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript"></SCRIPT><NOSCRIPT><A HREF="../../../../alltypes-noframe.html"><B>All Classes</B></A></NOSCRIPT></FONT></TD></TR><TR><TD COLSPAN="2" CLASS="NavBarCell1"><TABLE BORDER="0" WIDTH="100%" CELLPADDING="0" CELLSPACING="3" SUMMARY=""><TR ALIGN="center" VALIGN="top"><TD CLASS="NavBarCell1"><A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;
Expand Down
Loading

0 comments on commit 597c0b8

Please sign in to comment.