Skip to content

Commit

Permalink
REF: Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Automation51D authored and Automation51D committed Oct 14, 2023
1 parent 6de35bd commit 115ce39
Show file tree
Hide file tree
Showing 21 changed files with 478 additions and 51 deletions.
1 change: 1 addition & 0 deletions 4.4/annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ <h2 class="g-docs__page-title">Classes</h2></div><!--header-->
<tr class="c-table__row--depth-4" id="row_0_2_2_2_0_" style="display:none;"><td class="c-table__cell c-table__cell"><div class="c-table__indent"></div><span class="c-label">C</span><a class="el" href="classfiftyone_1_1pipeline_1_1core_1_1exceptions_1_1_engine_refresh_exception.html" target="_self">EngineRefreshException</a></td><td class="c-table__cell">Exception that can be thrown when an on-premise aspect engine fails to reload from one or more of it's data sources </td></tr>
<tr class="c-table__row--depth-4" id="row_0_2_2_2_1_" style="display:none;"><td class="c-table__cell c-table__cell"><div class="c-table__indent"></div><span class="c-label">C</span><a class="el" href="classfiftyone_1_1pipeline_1_1core_1_1exceptions_1_1_pipeline_configuration_exception.html" target="_self">PipelineConfigurationException</a></td><td class="c-table__cell">Exception that is thrown when the configuration options provided to <a class="el" href="">PipelineBuilder</a> are invalid </td></tr>
<tr class="c-table__row--depth-4" id="row_0_2_2_2_2_" style="display:none;"><td class="c-table__cell c-table__cell"><div class="c-table__indent"></div><span class="c-label">C</span><a class="el" href="classfiftyone_1_1pipeline_1_1core_1_1exceptions_1_1_pipeline_data_exception.html" target="_self">PipelineDataException</a></td><td class="c-table__cell">Exception that can be thrown when the available data does not match that which is expected </td></tr>
<tr class="c-table__row--depth-4" id="row_0_2_2_2_3_" style="display:none;"><td class="c-table__cell c-table__cell"><div class="c-table__indent"></div><span class="c-label">C</span><a class="el" href="classfiftyone_1_1pipeline_1_1core_1_1exceptions_1_1_property_not_loaded_exception.html" target="_self">PropertyNotLoadedException</a></td><td class="c-table__cell">Thrown to indicate that properties are not available yet but MAY(!) be re-requested later </td></tr>
<tr class="c-table__row--depth-3" id="row_0_2_2_3_"><td class="c-table__cell c-table__cell"><div class="c-table__indent"><span id="arr_0_2_2_3_" class="c-table__arrow" onclick="toggleFolder('0_2_2_3_')"></span></div><span class="c-label">N</span><b>flowelements</b></td><td class="c-table__cell"></td></tr>
<tr class="c-table__row--depth-4" id="row_0_2_2_3_0_" style="display:none;"><td class="c-table__cell c-table__cell"><div class="c-table__indent"></div><span class="c-label">C</span><a class="el" href="classfiftyone_1_1pipeline_1_1core_1_1flowelements_1_1_flow_data_factory_default.html" target="_self">FlowDataFactoryDefault</a></td><td class="c-table__cell">Default implementation of the <a class="el" href="">FlowDataFactory</a> interface </td></tr>
<tr class="c-table__row--depth-4" id="row_0_2_2_3_1_" style="display:none;"><td class="c-table__cell c-table__cell"><div class="c-table__indent"><span id="arr_0_2_2_3_1_" class="c-table__arrow" onclick="toggleFolder('0_2_2_3_1_')"></span></div><span class="c-label">C</span><a class="el" href="interfacefiftyone_1_1pipeline_1_1core_1_1flowelements_1_1_flow_element.html" target="_self">FlowElement</a></td><td class="c-table__cell">A component that processes a <a class="el" href="">FlowData</a> (by examining its evidence, or by examining data processed by other FlowElements) </td></tr>
Expand Down
3 changes: 2 additions & 1 deletion 4.4/annotated.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 7 additions & 7 deletions ...e_1_1pipeline_1_1cloudrequestengine_1_1flowelements_1_1_cloud_request_engine_default.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,19 +120,19 @@ <h2 class="g-docs__section-heading">
<!-- startMemberItem() -->
<tr class="c-table__row memitem:a1f6e28d6319cc25ff67ee01d92ab21df"><td class="c-table__cell"><a id="a1f6e28d6319cc25ff67ee01d92ab21df"></a>
<!-- insertMemberAlign -->
&#160;</td><td class="c-table__cell"><b>CloudRequestEngineDefault</b> (Logger logger, <a class="el" href="interfacefiftyone_1_1pipeline_1_1core_1_1data_1_1factories_1_1_element_data_factory.html">ElementDataFactory</a>&lt; <a class="el" href="classfiftyone_1_1pipeline_1_1cloudrequestengine_1_1data_1_1_cloud_request_data.html">CloudRequestData</a> &gt; aspectDataFactory, <a class="el" href="interfacefiftyone_1_1pipeline_1_1engines_1_1services_1_1_http_client.html">HttpClient</a> httpClient, String endPoint, String resourceKey, String propertiesEndpoint, String evidenceKeysEndpoint, int timeoutMillis) throws Exception
&#160;</td><td class="c-table__cell"><b>CloudRequestEngineDefault</b> (Logger logger, <a class="el" href="interfacefiftyone_1_1pipeline_1_1core_1_1data_1_1factories_1_1_element_data_factory.html">ElementDataFactory</a>&lt; <a class="el" href="classfiftyone_1_1pipeline_1_1cloudrequestengine_1_1data_1_1_cloud_request_data.html">CloudRequestData</a> &gt; aspectDataFactory, <a class="el" href="interfacefiftyone_1_1pipeline_1_1engines_1_1services_1_1_http_client.html">HttpClient</a> httpClient, String endPoint, String resourceKey, String propertiesEndpoint, String evidenceKeysEndpoint, int timeoutMillis)
</div></td></tr>
<!-- member dec start -->
<!-- startMemberItem() -->
<tr class="c-table__row memitem:aec42d0dd5e424a1fc54dc7ee876a8b2f"><td class="c-table__cell"><a id="aec42d0dd5e424a1fc54dc7ee876a8b2f"></a>
<!-- insertMemberAlign -->
&#160;</td><td class="c-table__cell"><b>CloudRequestEngineDefault</b> (Logger logger, <a class="el" href="interfacefiftyone_1_1pipeline_1_1core_1_1data_1_1factories_1_1_element_data_factory.html">ElementDataFactory</a>&lt; <a class="el" href="classfiftyone_1_1pipeline_1_1cloudrequestengine_1_1data_1_1_cloud_request_data.html">CloudRequestData</a> &gt; aspectDataFactory, <a class="el" href="interfacefiftyone_1_1pipeline_1_1engines_1_1services_1_1_http_client.html">HttpClient</a> httpClient, String endPoint, String resourceKey, String propertiesEndpoint, String evidenceKeysEndpoint, int timeoutMillis, String cloudRequestOrigin) throws Exception
&#160;</td><td class="c-table__cell"><b>CloudRequestEngineDefault</b> (Logger logger, <a class="el" href="interfacefiftyone_1_1pipeline_1_1core_1_1data_1_1factories_1_1_element_data_factory.html">ElementDataFactory</a>&lt; <a class="el" href="classfiftyone_1_1pipeline_1_1cloudrequestengine_1_1data_1_1_cloud_request_data.html">CloudRequestData</a> &gt; aspectDataFactory, <a class="el" href="interfacefiftyone_1_1pipeline_1_1engines_1_1services_1_1_http_client.html">HttpClient</a> httpClient, String endPoint, String resourceKey, String propertiesEndpoint, String evidenceKeysEndpoint, int timeoutMillis, String cloudRequestOrigin)
</div></td></tr>
<!-- member dec start -->
<!-- startMemberItem() -->
<tr class="c-table__row memitem:ab431fbe34b595c653f30a609ef3011f3"><td class="c-table__cell"><a id="ab431fbe34b595c653f30a609ef3011f3"></a>
<!-- insertMemberAlign -->
&#160;</td><td class="c-table__cell"><b>CloudRequestEngineDefault</b> (Logger logger, <a class="el" href="interfacefiftyone_1_1pipeline_1_1core_1_1data_1_1factories_1_1_element_data_factory.html">ElementDataFactory</a>&lt; <a class="el" href="classfiftyone_1_1pipeline_1_1cloudrequestengine_1_1data_1_1_cloud_request_data.html">CloudRequestData</a> &gt; aspectDataFactory, <a class="el" href="interfacefiftyone_1_1pipeline_1_1engines_1_1services_1_1_http_client.html">HttpClient</a> httpClient, String endPoint, String resourceKey, String licenseKey, String propertiesEndpoint, String evidenceKeysEndpoint, int timeoutMillis, String cloudRequestOrigin) throws Exception
&#160;</td><td class="c-table__cell"><b>CloudRequestEngineDefault</b> (Logger logger, <a class="el" href="interfacefiftyone_1_1pipeline_1_1core_1_1data_1_1factories_1_1_element_data_factory.html">ElementDataFactory</a>&lt; <a class="el" href="classfiftyone_1_1pipeline_1_1cloudrequestengine_1_1data_1_1_cloud_request_data.html">CloudRequestData</a> &gt; aspectDataFactory, <a class="el" href="interfacefiftyone_1_1pipeline_1_1engines_1_1services_1_1_http_client.html">HttpClient</a> httpClient, String endPoint, String resourceKey, String licenseKey, String propertiesEndpoint, String evidenceKeysEndpoint, int timeoutMillis, String cloudRequestOrigin)
</div></td></tr>
<!-- member dec start -->
<!-- startMemberItem() -->
Expand All @@ -158,14 +158,14 @@ <h2 class="g-docs__section-heading">
<!-- member dec start -->
<!-- startMemberItem() -->
<tr class="c-table__row memitem:aedea9fe60fe3fa3d505674f78a182ced"><td class="c-table__cell"><a class="el" href="interfacefiftyone_1_1pipeline_1_1core_1_1data_1_1_evidence_key_filter.html">EvidenceKeyFilter</a><!-- insertMemberAlign -->
&#160;</td><td class="c-table__cell"><a class="el" href="classfiftyone_1_1pipeline_1_1cloudrequestengine_1_1flowelements_1_1_cloud_request_engine_default.html#aedea9fe60fe3fa3d505674f78a182ced">getEvidenceKeyFilter</a> ()
&#160;</td><td class="c-table__cell"><a class="el" href="classfiftyone_1_1pipeline_1_1cloudrequestengine_1_1flowelements_1_1_cloud_request_engine_default.html#aedea9fe60fe3fa3d505674f78a182ced">getEvidenceKeyFilter</a> () throws CloudRequestException, AggregateException, PropertyNotLoadedException
<!-- startMemberDescription -->
<div class="c-table__desc memdesc:aedea9fe60fe3fa3d505674f78a182ced">Get a filter that will only include the evidence keys that this element can make use of. <a href="#aedea9fe60fe3fa3d505674f78a182ced">More...</a><!-- endMemberDescription -->
</div></td></tr>
<!-- member dec start -->
<!-- startMemberItem() -->
<tr class="c-table__row memitem:ae6238cb3082fdbd4fbed314c72db7413"><td class="c-table__cell">Map&lt;&#160;String,&#160;AccessiblePropertyMetaData.ProductMetaData&#160;&gt;<!-- insertMemberAlign -->
&#160;</td><td class="c-table__cell"><a class="el" href="classfiftyone_1_1pipeline_1_1cloudrequestengine_1_1flowelements_1_1_cloud_request_engine_default.html#ae6238cb3082fdbd4fbed314c72db7413">getPublicProperties</a> ()
&#160;</td><td class="c-table__cell"><a class="el" href="classfiftyone_1_1pipeline_1_1cloudrequestengine_1_1flowelements_1_1_cloud_request_engine_default.html#ae6238cb3082fdbd4fbed314c72db7413">getPublicProperties</a> () throws CloudRequestException, AggregateException, PropertyNotLoadedException
<!-- startMemberDescription -->
<div class="c-table__desc memdesc:ae6238cb3082fdbd4fbed314c72db7413">A collection of the properties that the cloud service can populate in the JSON response. <a href="#ae6238cb3082fdbd4fbed314c72db7413">More...</a><!-- endMemberDescription -->
</div></td></tr>
Expand Down Expand Up @@ -722,7 +722,7 @@ <h2 class="c-member__title"><span class="c-member__anchor"><a href="#aedea9fe60f
<!-- startParameterName -->
<td class="c-table__cell"><!-- endParameterName -->
</td><td>)</td>
<td><!-- endParameterList -->
<td> throws <a class="el" href="classfiftyone_1_1pipeline_1_1cloudrequestengine_1_1_cloud_request_exception.html">CloudRequestException</a>, <a class="el" href="classfiftyone_1_1pipeline_1_1exceptions_1_1_aggregate_exception.html">AggregateException</a>, <a class="el" href="classfiftyone_1_1pipeline_1_1core_1_1exceptions_1_1_property_not_loaded_exception.html">PropertyNotLoadedException</a><!-- endParameterList -->
</td>
</tr>
<!-- endMemberDoc -->
Expand Down Expand Up @@ -798,7 +798,7 @@ <h2 class="c-member__title"><span class="c-member__anchor"><a href="#ae6238cb308
<!-- startParameterName -->
<td class="c-table__cell"><!-- endParameterName -->
</td><td>)</td>
<td><!-- endParameterList -->
<td> throws <a class="el" href="classfiftyone_1_1pipeline_1_1cloudrequestengine_1_1_cloud_request_exception.html">CloudRequestException</a>, <a class="el" href="classfiftyone_1_1pipeline_1_1exceptions_1_1_aggregate_exception.html">AggregateException</a>, <a class="el" href="classfiftyone_1_1pipeline_1_1core_1_1exceptions_1_1_property_not_loaded_exception.html">PropertyNotLoadedException</a><!-- endParameterList -->
</td>
</tr>
<!-- endMemberDoc -->
Expand Down
Loading

0 comments on commit 115ce39

Please sign in to comment.