docs: regenerate docs

camunda-community-hub · May 27, 2024 · eb24358 · eb24358
1 parent 1c7c7cd
commit eb24358
Show file tree

Hide file tree

Showing 202 changed files with 924 additions and 735 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME           = "Zeebe C# Client"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.5.0
+PROJECT_NUMBER         = 2.6.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

diff --git a/docs/annotated.html b/docs/annotated.html
diff --git a/docs/annotated_dup.js b/docs/annotated_dup.js
diff --git a/docs/classes.html b/docs/classes.html
diff --git a/docs/d0/d12/interfaceIDecisionRequirementsMetadata.html b/docs/d0/d12/interfaceIDecisionRequirementsMetadata.html
@@ -26,7 +26,7 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.5.0</span>
+   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.6.0</span>
    </div>
    <div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
   </td>
@@ -196,7 +196,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a703fdf9cd478efd8cc4c87ae
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="../../d0/d12/interfaceIDecisionRequirementsMetadata.html">IDecisionRequirementsMetadata</a></li>
-    <li class="footer">Generated on Thu Feb 1 2024 15:47:54 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
+    <li class="footer">Generated on Mon May 27 2024 08:34:47 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
   </ul>
 </div>
 </body>

diff --git a/docs/d0/d39/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IResolveIncidentCommandStep1.html b/docs/d0/d39/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IResolveIncidentCommandStep1.html
@@ -26,7 +26,7 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.5.0</span>
+   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.6.0</span>
    </div>
    <div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
   </td>
@@ -122,7 +122,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a></li><li class="navelem"><a class="el" href="../../da/d88/namespaceZeebe_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="../../d5/df7/namespaceZeebe_1_1Client_1_1Api.html">Api</a></li><li class="navelem"><a class="el" href="../../d9/def/namespaceZeebe_1_1Client_1_1Api_1_1Commands.html">Commands</a></li><li class="navelem"><a class="el" href="../../d0/d39/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IResolveIncidentCommandStep1.html">IResolveIncidentCommandStep1</a></li>
-    <li class="footer">Generated on Thu Feb 1 2024 15:47:54 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
+    <li class="footer">Generated on Mon May 27 2024 08:34:47 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
   </ul>
 </div>
 </body>

diff --git a/...faceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICancelProcessInstanceCommandStep1-members.html b/...faceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICancelProcessInstanceCommandStep1-members.html
@@ -26,7 +26,7 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.5.0</span>
+   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.6.0</span>
    </div>
    <div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
   </td>
@@ -103,7 +103,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Thu Feb 1 2024 15:47:54 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
+    <li class="footer">Generated on Mon May 27 2024 08:34:47 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
   </ul>
 </div>
 </body>

diff --git a/docs/d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html b/docs/d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html
@@ -26,7 +26,7 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.5.0</span>
+   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.6.0</span>
    </div>
    <div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
   </td>
@@ -200,7 +200,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a77b27701c3be61c204cb02d4
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="../../d0/d4b/interfaceIModifyProcessInstanceCommandStep3.html">IModifyProcessInstanceCommandStep3</a></li>
-    <li class="footer">Generated on Thu Feb 1 2024 15:47:54 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
+    <li class="footer">Generated on Mon May 27 2024 08:34:47 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
   </ul>
 </div>
 </body>

diff --git a/docs/d0/d9e/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IActivateJobsCommandStep2.html b/docs/d0/d9e/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IActivateJobsCommandStep2.html
@@ -26,7 +26,7 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.5.0</span>
+   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.6.0</span>
    </div>
    <div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
   </td>
@@ -141,7 +141,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a812d2062fe9630879fdcba09
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a></li><li class="navelem"><a class="el" href="../../da/d88/namespaceZeebe_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="../../d5/df7/namespaceZeebe_1_1Client_1_1Api.html">Api</a></li><li class="navelem"><a class="el" href="../../d9/def/namespaceZeebe_1_1Client_1_1Api_1_1Commands.html">Commands</a></li><li class="navelem"><a class="el" href="../../d0/d9e/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IActivateJobsCommandStep2.html">IActivateJobsCommandStep2</a></li>
-    <li class="footer">Generated on Thu Feb 1 2024 15:47:54 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
+    <li class="footer">Generated on Mon May 27 2024 08:34:47 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
   </ul>
 </div>
 </body>

diff --git a/docs/d0/dab/interfaceZeebe_1_1Client_1_1Api_1_1Responses_1_1IPublishMessageResponse.html b/docs/d0/dab/interfaceZeebe_1_1Client_1_1Api_1_1Responses_1_1IPublishMessageResponse.html
@@ -26,7 +26,7 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.5.0</span>
+   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.6.0</span>
    </div>
    <div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
   </td>
@@ -108,7 +108,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a></li><li class="navelem"><a class="el" href="../../da/d88/namespaceZeebe_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="../../d5/df7/namespaceZeebe_1_1Client_1_1Api.html">Api</a></li><li class="navelem"><a class="el" href="../../dd/db3/namespaceZeebe_1_1Client_1_1Api_1_1Responses.html">Responses</a></li><li class="navelem"><a class="el" href="../../d0/dab/interfaceZeebe_1_1Client_1_1Api_1_1Responses_1_1IPublishMessageResponse.html">IPublishMessageResponse</a></li>
-    <li class="footer">Generated on Thu Feb 1 2024 15:47:54 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
+    <li class="footer">Generated on Mon May 27 2024 08:34:47 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
   </ul>
 </div>
 </body>

diff --git a/...b3/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICreateProcessInstanceCommandStep3.html b/...b3/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICreateProcessInstanceCommandStep3.html
@@ -26,7 +26,7 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.5.0</span>
+   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.6.0</span>
    </div>
    <div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
   </td>
@@ -103,7 +103,8 @@
  <div class="center">
   <img src="../../d0/db3/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICreateProcessInstanceCommandStep3.png" usemap="#Zeebe.Client.Api.Commands.ICreateProcessInstanceCommandStep3_map" alt=""/>
   <map id="Zeebe.Client.Api.Commands.ICreateProcessInstanceCommandStep3_map" name="Zeebe.Client.Api.Commands.ICreateProcessInstanceCommandStep3_map">
-<area href="../../d5/d5e/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep.html" alt="Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep&lt; IProcessInstanceResponse &gt;" shape="rect" coords="0,0,517,24"/>
+<area href="../../d5/d5e/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep.html" alt="Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep&lt; IProcessInstanceResponse &gt;" shape="rect" coords="0,0,553,24"/>
+<area href="../../da/d91/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ITenantIdCommandStep.html" alt="Zeebe.Client.Api.Commands.ITenantIdCommandStep&lt; ICreateProcessInstanceCommandStep3 &gt;" shape="rect" coords="563,0,1116,24"/>
   </map>
 </div></div>
 <table class="memberdecls">
@@ -119,6 +120,10 @@
 <tr class="memitem:a00faa4eeae2f6a2d2dc18e2d1153b214 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep"><td class="memItemLeft" align="right" valign="top">Task&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d5e/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep.html#a00faa4eeae2f6a2d2dc18e2d1153b214">SendWithRetry</a> (TimeSpan? timeout=null, CancellationToken token=default)</td></tr>
 <tr class="memdesc:a00faa4eeae2f6a2d2dc18e2d1153b214 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends the command with retry to the <a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a> broker. This operation is asynchronous. In case of success, the task returns the event that was generated by the <a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a> broker in response to the command. If the sending of the command fails, because of broker back pressure or network issues the request is retried until the command succeeds. The wait time between retries can be configured on the ZeebeClientBuilder. Per default the wait time is based on power two, which means 2^1 seconds, 2^2 seconds etc. until it reaches the maximum of one minute.  <a href="../../d5/d5e/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep.html#a00faa4eeae2f6a2d2dc18e2d1153b214">More...</a><br /></td></tr>
 <tr class="separator:a00faa4eeae2f6a2d2dc18e2d1153b214 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFinalCommandWithRetryStep"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="inherit_header pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ITenantIdCommandStep"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ITenantIdCommandStep')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../da/d91/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ITenantIdCommandStep.html">Zeebe.Client.Api.Commands.ITenantIdCommandStep&lt; ICreateProcessInstanceCommandStep3 &gt;</a></td></tr>
+<tr class="memitem:a98067193e5fb0bb6b7e8966397997510 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ITenantIdCommandStep"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d91/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ITenantIdCommandStep.html#a98067193e5fb0bb6b7e8966397997510">AddTenantId</a> (string tenantId)</td></tr>
+<tr class="memdesc:a98067193e5fb0bb6b7e8966397997510 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ITenantIdCommandStep"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the tenantId for the resource.   <a href="../../da/d91/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ITenantIdCommandStep.html#a98067193e5fb0bb6b7e8966397997510">More...</a><br /></td></tr>
+<tr class="separator:a98067193e5fb0bb6b7e8966397997510 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ITenantIdCommandStep"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Member Function Documentation</h2>
 <a id="a40d4cef0731118ab14bdc9ae4b4cb007" name="a40d4cef0731118ab14bdc9ae4b4cb007"></a>
@@ -177,7 +182,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a46f6eddd29cace93eebbfe07
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a></li><li class="navelem"><a class="el" href="../../da/d88/namespaceZeebe_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="../../d5/df7/namespaceZeebe_1_1Client_1_1Api.html">Api</a></li><li class="navelem"><a class="el" href="../../d9/def/namespaceZeebe_1_1Client_1_1Api_1_1Commands.html">Commands</a></li><li class="navelem"><a class="el" href="../../d0/db3/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICreateProcessInstanceCommandStep3.html">ICreateProcessInstanceCommandStep3</a></li>
-    <li class="footer">Generated on Thu Feb 1 2024 15:47:54 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
+    <li class="footer">Generated on Mon May 27 2024 08:34:47 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
   </ul>
 </div>
 </body>

diff --git a/...aceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICreateProcessInstanceCommandStep3.png b/...aceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICreateProcessInstanceCommandStep3.png
diff --git a/docs/d0/dd0/interfaceZeebe_1_1Client_1_1Api_1_1Responses_1_1IProcessInstanceResult.html b/docs/d0/dd0/interfaceZeebe_1_1Client_1_1Api_1_1Responses_1_1IProcessInstanceResult.html
@@ -26,7 +26,7 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.5.0</span>
+   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.6.0</span>
    </div>
    <div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
   </td>
@@ -221,7 +221,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae3fd7cbfefa940fbb1baf327
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a></li><li class="navelem"><a class="el" href="../../da/d88/namespaceZeebe_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="../../d5/df7/namespaceZeebe_1_1Client_1_1Api.html">Api</a></li><li class="navelem"><a class="el" href="../../dd/db3/namespaceZeebe_1_1Client_1_1Api_1_1Responses.html">Responses</a></li><li class="navelem"><a class="el" href="../../d0/dd0/interfaceZeebe_1_1Client_1_1Api_1_1Responses_1_1IProcessInstanceResult.html">IProcessInstanceResult</a></li>
-    <li class="footer">Generated on Thu Feb 1 2024 15:47:54 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
+    <li class="footer">Generated on Mon May 27 2024 08:34:47 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
   </ul>
 </div>
 </body>

diff --git a/docs/d0/dd1/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobWorkerBuilderStep2-members.html b/docs/d0/dd1/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobWorkerBuilderStep2-members.html
@@ -26,7 +26,7 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="../../zeebe-logo.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.5.0</span>
+   <div id="projectname">Zeebe C# Client<span id="projectnumber">&#160;2.6.0</span>
    </div>
    <div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
   </td>
@@ -104,7 +104,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Thu Feb 1 2024 15:47:54 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
+    <li class="footer">Generated on Mon May 27 2024 08:34:47 for Zeebe C# Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
   </ul>
 </div>
 </body>