Deployed 7334b45 with MkDocs version: 1.6.1

advanced/dynamic-job-control/index.html

@@ -213,21 +213,40 @@ <h2 id="retrieving-a-job-schedule-by-name">Retrieving a job schedule by name<a c
 
 <p>The cron expression and time zone can be <code>null</code> even if the job was found. This indicates that the job has no schedule (like dependent jobs).</p>
 <h2 id="disabling-and-enabling-jobs">Disabling and enabling jobs<a class="headerlink" href="#disabling-and-enabling-jobs" title="Permanent link">&para;</a></h2>
-<p>To disable a job, use the <code>DisableJob</code> method:</p>
+<p>There are two ways to disable a job from the scheduler. By name or by type.</p>
+<p>To disable a job by name:</p>
 <div class="codehilite"><pre><span></span><code><span class="n">app</span><span class="p">.</span><span class="n">MapPut</span><span class="p">(</span><span class="s">&quot;/disable-job&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="n">IRuntimeJobRegistry</span><span class="w"> </span><span class="n">registry</span><span class="p">)</span><span class="w"> </span><span class="o">=&gt;</span><span class="w"> </span>
 <span class="p">{</span>
 <span class="w">    </span><span class="n">registry</span><span class="p">.</span><span class="n">DisableJob</span><span class="p">(</span><span class="s">&quot;MyName&quot;</span><span class="p">);</span>
 <span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="n">TypedResults</span><span class="p">.</span><span class="n">Ok</span><span class="p">();</span>
 <span class="p">});</span>
 </code></pre></div>
 
+<p>That will prevent one job named <code>MyName</code> from being scheduled.</p>
+<p>In contrast disabling by type will disable all jobs of the given type (so zero to many jobs):</p>
+<div class="codehilite"><pre><span></span><code><span class="n">app</span><span class="p">.</span><span class="n">MapPut</span><span class="p">(</span><span class="s">&quot;/disable-job&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="n">IRuntimeJobRegistry</span><span class="w"> </span><span class="n">registry</span><span class="p">)</span><span class="w"> </span><span class="o">=&gt;</span>
+<span class="p">{</span>
+<span class="w">    </span><span class="n">registry</span><span class="p">.</span><span class="n">DisableJob</span><span class="o">&lt;</span><span class="n">SampleJob</span><span class="o">&gt;</span><span class="p">();</span><span class="w"> </span><span class="c1">// Alternatively DisableJob(typeof(SampleJob))</span>
+<span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="n">TypedResults</span><span class="p">.</span><span class="n">Ok</span><span class="p">();</span>
+<span class="p">});</span>
+</code></pre></div>
+
 <p>If a job is disabled, it will not be scheduled anymore. Any planned job will be cancelled and the job will be removed from the scheduler.</p>
-<p>To enable a job, use the <code>EnableJob</code> method:</p>
+<p>Of course, it&rsquo;s also possible to enable back previously disabled jobs.</p>
+<p>To enable a job by name:</p>
 <div class="codehilite"><pre><span></span><code><span class="n">app</span><span class="p">.</span><span class="n">MapPut</span><span class="p">(</span><span class="s">&quot;/enable-job&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="n">IRuntimeJobRegistry</span><span class="w"> </span><span class="n">registry</span><span class="p">)</span><span class="w"> </span><span class="o">=&gt;</span><span class="w"> </span>
 <span class="p">{</span>
 <span class="w">    </span><span class="n">registry</span><span class="p">.</span><span class="n">EnableJob</span><span class="p">(</span><span class="s">&quot;MyName&quot;</span><span class="p">);</span>
 <span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="n">TypedResults</span><span class="p">.</span><span class="n">Ok</span><span class="p">();</span>
 <span class="p">});</span>
+</code></pre></div>
+
+<p>And similarly, to enable all jobs of the given type (so zero to many jobs):</p>
+<div class="codehilite"><pre><span></span><code><span class="n">app</span><span class="p">.</span><span class="n">MapPut</span><span class="p">(</span><span class="s">&quot;/enable-job&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="n">IRuntimeJobRegistry</span><span class="w"> </span><span class="n">registry</span><span class="p">)</span><span class="w"> </span><span class="o">=&gt;</span>
+<span class="p">{</span>
+<span class="w">    </span><span class="n">registry</span><span class="p">.</span><span class="n">EnableJob</span><span class="o">&lt;</span><span class="n">SampleJob</span><span class="o">&gt;</span><span class="p">();</span><span class="w"> </span><span class="c1">// Alternatively EnableJob(typeof(SampleJob))</span>
+<span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="n">TypedResults</span><span class="p">.</span><span class="n">Ok</span><span class="p">();</span>
+<span class="p">});</span>
 </code></pre></div>
 
             </div>

features/instant-jobs/index.html

@@ -69,6 +69,8 @@
     </li>
     <li class="toctree-l2"><a class="reference internal" href="#minimal-api">Minimal API</a>
     </li>
+    <li class="toctree-l2"><a class="reference internal" href="#instrumentation">Instrumentation</a>
+    </li>
     </ul>
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../concurrency-control/">Concurrency control</a>
@@ -216,6 +218,15 @@ <h2 id="minimal-api">Minimal API<a class="headerlink" href="#minimal-api" title=
 <span class="w">    </span><span class="p">});</span>
 <span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="n">TypedResults</span><span class="p">.</span><span class="n">Ok</span><span class="p">();</span>
 <span class="p">});</span>
+</code></pre></div>
+
+<h2 id="instrumentation">Instrumentation<a class="headerlink" href="#instrumentation" title="Permanent link">&para;</a></h2>
+<p>All members of the <code>IInstantJobRegistry</code> interface return the correlation id of the triggered job (See <a href="../model-dependencies/#tracing-requests-of-dependencies-via-correlationid"><em>&ldquo;Tracing requests of dependencies via <code>CorrelationId</code>&ldquo;</em></a>.).</p>
+<div class="codehilite"><pre><span></span><code><span class="n">Guid</span><span class="w"> </span><span class="n">oneCorrelationId</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">jobRegistry</span><span class="p">.</span><span class="n">RunInstantJob</span><span class="o">&lt;</span><span class="n">MyJob</span><span class="o">&gt;</span><span class="p">();</span>
+
+<span class="n">Guid</span><span class="w"> </span><span class="n">anotherCorrelationId</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">jobRegistry</span><span class="p">.</span><span class="n">RunScheduledJob</span><span class="o">&lt;</span><span class="n">MyJob</span><span class="o">&gt;</span><span class="p">(</span><span class="n">TimeSpan</span><span class="p">.</span><span class="n">FromMinutes</span><span class="p">(</span><span class="m">5</span><span class="p">));</span>
+
+<span class="na">[...]</span>
 </code></pre></div>
 
             </div>

getting-started/index.html

@@ -136,7 +136,7 @@ <h2 id="1-install-the-package">1. Install the package<a class="headerlink" href=
 </code></pre></div>
 
 <p>Alternatively add the package reference to your <code>.csproj</code> file:</p>
-<div class="codehilite"><pre><span></span><code><span class="nt">&lt;PackageReference</span><span class="w"> </span><span class="na">Include=</span><span class="s">&quot;NCronJob&quot;</span><span class="w"> </span><span class="na">Version=</span><span class="s">&quot;4.0.2&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
+<div class="codehilite"><pre><span></span><code><span class="nt">&lt;PackageReference</span><span class="w"> </span><span class="na">Include=</span><span class="s">&quot;NCronJob&quot;</span><span class="w"> </span><span class="na">Version=</span><span class="s">&quot;4.1.0&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
 </code></pre></div>
 
 <h2 id="2-create-a-job">2. Create a job<a class="headerlink" href="#2-create-a-job" title="Permanent link">&para;</a></h2>

index.html

@@ -194,5 +194,5 @@ <h1 id="ncronjob">NCronJob<a class="headerlink" href="#ncronjob" title="Permanen
 
 <!--
 MkDocs version : 1.6.1
-Build Date UTC : 2024-12-28 19:57:28.442682+00:00
+Build Date UTC : 2025-01-02 21:21:12.663126+00:00
 -->

sitemap.xml

@@ -2,78 +2,78 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://docs.ncronjob.dev/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/getting-started/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/advanced/dynamic-job-control/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/advanced/global-concurrency/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/advanced/log-level/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/features/concurrency-control/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/features/define-and-schedule-jobs/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/features/exception-handler/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/features/instant-jobs/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/features/minimal-api/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/features/model-dependencies/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/features/multiple-cron-expressions/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/features/notifications/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/features/parameters/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/features/retry-support/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/features/startup-jobs/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/migration/v2/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/migration/v3/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
     <url>
          <loc>https://docs.ncronjob.dev/migration/v4/</loc>
-         <lastmod>2024-12-28</lastmod>
+         <lastmod>2025-01-02</lastmod>
     </url>
 </urlset>