nautobot 2.4.14__py3-none-any.whl → 2.4.15__py3-none-any.whl

nautobot/project-static/docs/code-reference/nautobot/apps/jobs.html

@@ -9265,6 +9265,29 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/migration/ui-component-framework/breadcrumbs-titles.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    Breadcrumbs and titles
+    
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -11229,6 +11252,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11265,6 +11289,7 @@ with shared functionality; if no such sharing is required, use Job class instead
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11310,6 +11335,7 @@ with shared functionality; if no such sharing is required, use Job class instead
 
 
 
+
     </div>
 
 </div>
@@ -11345,7 +11371,7 @@ with shared functionality; if no such sharing is required, use Job class instead
                 <code>status</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11361,7 +11387,7 @@ with shared functionality; if no such sharing is required, use Job class instead
                 <code>retval</code>
             </td>
             <td>
-                  <code>Any</code>
+                  <code><span title="Any">Any</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11377,7 +11403,7 @@ with shared functionality; if no such sharing is required, use Job class instead
                 <code>task_id</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11393,7 +11419,7 @@ with shared functionality; if no such sharing is required, use Job class instead
                 <code>args</code>
             </td>
             <td>
-                  <code>tuple</code>
+                  <code><span title="tuple">tuple</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11409,7 +11435,7 @@ with shared functionality; if no such sharing is required, use Job class instead
                 <code>kwargs</code>
             </td>
             <td>
-                  <code>dict</code>
+                  <code><span title="dict">dict</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11462,6 +11488,7 @@ with shared functionality; if no such sharing is required, use Job class instead
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -11485,6 +11512,7 @@ with shared functionality; if no such sharing is required, use Job class instead
 <p><code>approval_view</code> will disable all fields from modification and is used to display the form
 during a approval review workflow.</p>
 
+
     </div>
 
 </div>
@@ -11507,6 +11535,7 @@ during a approval review workflow.</p>
         <p>Dynamically generate a Django form class corresponding to the variables in this Job.</p>
 <p>In most cases you should use <code>.as_form()</code> instead of calling this method directly.</p>
 
+
     </div>
 
 </div>
@@ -11541,7 +11570,7 @@ during a approval review workflow.</p>
                 <code>task_id</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11557,7 +11586,7 @@ during a approval review workflow.</p>
                 <code>args</code>
             </td>
             <td>
-                  <code>Tuple</code>
+                  <code><span title="Tuple">Tuple</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11573,7 +11602,7 @@ during a approval review workflow.</p>
                 <code>kwargs</code>
             </td>
             <td>
-                  <code>Dict</code>
+                  <code><span title="Dict">Dict</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11599,7 +11628,7 @@ during a approval review workflow.</p>
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>Any</code>
+                  <code><span title="Any">Any</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11612,6 +11641,7 @@ since <code>self.run()</code> will <strong>not</strong> be called in such a case
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -11634,6 +11664,7 @@ since <code>self.run()</code> will <strong>not</strong> be called in such a case
 - my_plugin.jobs.MyPluginJob - App-provided Job
 - git_repository.jobs.myjob.MyJob - GitRepository Job</p>
 
+
     </div>
 
 </div>
@@ -11652,6 +11683,7 @@ since <code>self.run()</code> will <strong>not</strong> be called in such a case
         <p>Dotted class_path, suitable for use in things like Python logger names.</p>
 <p>Deprecated as of Nautobot 2.0: just use .class_path instead.</p>
 
+
     </div>
 
 </div>
@@ -11669,6 +11701,7 @@ since <code>self.run()</code> will <strong>not</strong> be called in such a case
 
         <p>Escape various characters so that the class_path can be used as a jQuery selector.</p>
 
+
     </div>
 
 </div>
@@ -11703,7 +11736,7 @@ since <code>self.run()</code> will <strong>not</strong> be called in such a case
                 <code>filename</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11719,7 +11752,7 @@ since <code>self.run()</code> will <strong>not</strong> be called in such a case
                 <code>content</code>
             </td>
             <td>
-                  <code>(str, bytes)</code>
+                  <code>(<span title="str">str</span>, <span title="bytes">bytes</span>)</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11745,7 +11778,7 @@ since <code>self.run()</code> will <strong>not</strong> be called in such a case
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>ValueError</code>
+                  <code><span title="ValueError">ValueError</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11779,6 +11812,7 @@ since <code>self.run()</code> will <strong>not</strong> be called in such a case
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -11805,6 +11839,7 @@ model instances for ObjectVar.</p>
 exceptions here, we leave it up the caller to handle those cases. The normal job execution code
 path would consider this a failure of the job execution, as described in <code>nautobot.extras.jobs.run_job</code>.</p>
 
+
     </div>
 
 </div>
@@ -11822,6 +11857,7 @@ path would consider this a failure of the job execution, as described in <code>n
 
         <p>Mark this job as failed without immediately raising an exception and aborting.</p>
 
+
     </div>
 
 </div>
@@ -11839,6 +11875,7 @@ path would consider this a failure of the job execution, as described in <code>n
 
         <p>Deprecated as of Nautobot 2.2.3.</p>
 
+
     </div>
 
 </div>
@@ -11856,6 +11893,7 @@ path would consider this a failure of the job execution, as described in <code>n
 
         <p>Return data from a JSON file</p>
 
+
     </div>
 
 </div>
@@ -11873,6 +11911,7 @@ path would consider this a failure of the job execution, as described in <code>n
 
         <p>Return data from a YAML file</p>
 
+
     </div>
 
 </div>
@@ -11908,7 +11947,7 @@ path would consider this a failure of the job execution, as described in <code>n
                 <code>exc</code>
             </td>
             <td>
-                  <code>Any</code>
+                  <code><span title="Any">Any</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11925,7 +11964,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
                 <code>task_id</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11941,7 +11980,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
                 <code>args</code>
             </td>
             <td>
-                  <code>Tuple</code>
+                  <code><span title="Tuple">Tuple</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11957,7 +11996,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
                 <code>kwargs</code>
             </td>
             <td>
-                  <code>Dict</code>
+                  <code><span title="Dict">Dict</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12010,6 +12049,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -12045,7 +12085,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
                 <code>exc</code>
             </td>
             <td>
-                  <code>Exception</code>
+                  <code><span title="Exception">Exception</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12061,7 +12101,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
                 <code>task_id</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12077,7 +12117,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
                 <code>args</code>
             </td>
             <td>
-                  <code>Tuple</code>
+                  <code><span title="Tuple">Tuple</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12093,7 +12133,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
                 <code>kwargs</code>
             </td>
             <td>
-                  <code>Dict</code>
+                  <code><span title="Dict">Dict</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12146,6 +12186,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -12181,7 +12222,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
                 <code>retval</code>
             </td>
             <td>
-                  <code>Any</code>
+                  <code><span title="Any">Any</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12197,7 +12238,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
                 <code>task_id</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12213,7 +12254,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
                 <code>args</code>
             </td>
             <td>
-                  <code>Tuple</code>
+                  <code><span title="Tuple">Tuple</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12229,7 +12270,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
                 <code>kwargs</code>
             </td>
             <td>
-                  <code>Dict</code>
+                  <code><span title="Dict">Dict</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12266,6 +12307,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -12287,6 +12329,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
 
         <p>Process dict and return kwargs that exist as ScriptVariables on this job.</p>
 
+
     </div>
 
 </div>
@@ -12305,6 +12348,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
         <p>Return all relevant classproperties as a dict.</p>
 <p>Used for convenient rendering into job_edit.html via the <code>json_script</code> template tag.</p>
 
+
     </div>
 
 </div>
@@ -12322,6 +12366,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
 
         <p>Deprecated - use class_path classproperty instead.</p>
 
+
     </div>
 
 </div>
@@ -12339,6 +12384,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
 
         <p>Method invoked when this Job is run.</p>
 
+
     </div>
 
 </div>
@@ -12363,6 +12409,7 @@ such as if the Job called <code>self.fail()</code> rather than raising an except
 of an ObjectVar into the pk value.</p>
 <p>These are converted back during job execution.</p>
 
+
     </div>
 
 </div>
@@ -12380,6 +12427,7 @@ of an ObjectVar into the pk value.</p>
 
         <p>Cache key for singleton jobs.</p>
 
+
     </div>
 
 </div>
@@ -12405,7 +12453,7 @@ of an ObjectVar into the pk value.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.ScriptVariable (nautobot.extras.jobs.ScriptVariable)" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
 
 
         <p>Boolean representation (true/false). Renders as a checkbox.</p>
@@ -12418,6 +12466,7 @@ of an ObjectVar into the pk value.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12449,7 +12498,7 @@ of an ObjectVar into the pk value.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.ScriptVariable (nautobot.extras.jobs.ScriptVariable)" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
 
 
         <p>Select one of several predefined static choices, passed as a list of two-tuples. Example:</p>
@@ -12470,6 +12519,7 @@ of an ObjectVar into the pk value.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12514,6 +12564,7 @@ of an ObjectVar into the pk value.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12545,7 +12596,7 @@ of an ObjectVar into the pk value.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.BooleanVar" href="#nautobot.apps.jobs.BooleanVar">BooleanVar</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.BooleanVar (nautobot.extras.jobs.BooleanVar)" href="#nautobot.apps.jobs.BooleanVar">BooleanVar</a></code></p>
 
 
         <p>Special boolean variable that bypasses approval requirements if this is set to True on job execution.</p>
@@ -12558,6 +12609,7 @@ of an ObjectVar into the pk value.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12589,7 +12641,7 @@ of an ObjectVar into the pk value.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.ScriptVariable (nautobot.extras.jobs.ScriptVariable)" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
 
 
         <p>An uploaded file.</p>
@@ -12602,6 +12654,7 @@ of an ObjectVar into the pk value.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12633,7 +12686,7 @@ of an ObjectVar into the pk value.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.Job" href="#nautobot.apps.jobs.Job">Job</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.Job (nautobot.extras.jobs.Job)" href="#nautobot.apps.jobs.Job">Job</a></code></p>
 
 
         <p>System Job to perform a dry run on a Git repository.</p>
@@ -12646,6 +12699,7 @@ of an ObjectVar into the pk value.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12677,7 +12731,7 @@ of an ObjectVar into the pk value.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.Job" href="#nautobot.apps.jobs.Job">Job</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.Job (nautobot.extras.jobs.Job)" href="#nautobot.apps.jobs.Job">Job</a></code></p>
 
 
         <p>System job to clone and/or pull a Git repository, then invoke <code>refresh_datasource_content()</code>.</p>
@@ -12690,6 +12744,7 @@ of an ObjectVar into the pk value.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12721,7 +12776,7 @@ of an ObjectVar into the pk value.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.ScriptVariable (nautobot.extras.jobs.ScriptVariable)" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
 
 
         <p>An IPv4 or IPv6 address without a mask.</p>
@@ -12734,6 +12789,7 @@ of an ObjectVar into the pk value.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12765,7 +12821,7 @@ of an ObjectVar into the pk value.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.ScriptVariable (nautobot.extras.jobs.ScriptVariable)" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
 
 
         <p>An IPv4 or IPv6 address with a mask.</p>
@@ -12778,6 +12834,7 @@ of an ObjectVar into the pk value.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12809,7 +12866,7 @@ of an ObjectVar into the pk value.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.ScriptVariable (nautobot.extras.jobs.ScriptVariable)" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
 
 
         <p>An IPv4 or IPv6 prefix.</p>
@@ -12822,6 +12879,7 @@ of an ObjectVar into the pk value.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12853,7 +12911,7 @@ of an ObjectVar into the pk value.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.ScriptVariable (nautobot.extras.jobs.ScriptVariable)" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
 
 
         <p>Integer representation. Can enforce minimum/maximum values.</p>
@@ -12866,6 +12924,7 @@ of an ObjectVar into the pk value.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12897,7 +12956,7 @@ of an ObjectVar into the pk value.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.ScriptVariable (nautobot.extras.jobs.ScriptVariable)" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
 
 
         <p>Like TextVar but with native serializing of JSON data.</p>
@@ -12910,6 +12969,7 @@ of an ObjectVar into the pk value.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12941,7 +13001,7 @@ of an ObjectVar into the pk value.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.BaseJob" href="#nautobot.apps.jobs.BaseJob">BaseJob</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.BaseJob (nautobot.extras.jobs.BaseJob)" href="#nautobot.apps.jobs.BaseJob">BaseJob</a></code></p>
 
 
         <p>Classes which inherit from this model will appear in the list of available jobs.</p>
@@ -12954,6 +13014,7 @@ of an ObjectVar into the pk value.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12985,7 +13046,7 @@ of an ObjectVar into the pk value.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.Job" href="#nautobot.apps.jobs.Job">Job</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.Job (nautobot.extras.jobs.Job)" href="#nautobot.apps.jobs.Job">Job</a></code></p>
 
 
         <p>Base class for job button receivers. Job button receivers are jobs that are initiated
@@ -12999,6 +13060,7 @@ from UI buttons and are not intended to be run from the job form UI or API like
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13053,6 +13115,7 @@ from UI buttons and are not intended to be run from the job form UI or API like
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -13070,6 +13133,7 @@ from UI buttons and are not intended to be run from the job form UI or API like
 
         <p>JobButtonReceiver subclasses generally shouldn't need to override this method.</p>
 
+
     </div>
 
 </div>
@@ -13095,7 +13159,7 @@ from UI buttons and are not intended to be run from the job form UI or API like
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.Job" href="#nautobot.apps.jobs.Job">Job</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.Job (nautobot.extras.jobs.Job)" href="#nautobot.apps.jobs.Job">Job</a></code></p>
 
 
         <p>Base class for job hook receivers. Job hook receivers are jobs that are initiated
@@ -13109,6 +13173,7 @@ from object changes and are not intended to be run from the UI or API like stand
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13165,7 +13230,7 @@ from object changes and are not intended to be run from the UI or API like stand
                 <code>action</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13195,6 +13260,7 @@ from object changes and are not intended to be run from the UI or API like stand
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -13212,6 +13278,7 @@ from object changes and are not intended to be run from the UI or API like stand
 
         <p>JobHookReceiver subclasses generally shouldn't need to override this method.</p>
 
+
     </div>
 
 </div>
@@ -13237,7 +13304,7 @@ from object changes and are not intended to be run from the UI or API like stand
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ChoiceVar" href="#nautobot.apps.jobs.ChoiceVar">ChoiceVar</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.ChoiceVar (nautobot.extras.jobs.ChoiceVar)" href="#nautobot.apps.jobs.ChoiceVar">ChoiceVar</a></code></p>
 
 
         <p>Like ChoiceVar, but allows for the selection of multiple choices.</p>
@@ -13250,6 +13317,7 @@ from object changes and are not intended to be run from the UI or API like stand
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13281,7 +13349,7 @@ from object changes and are not intended to be run from the UI or API like stand
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ObjectVar" href="#nautobot.apps.jobs.ObjectVar">ObjectVar</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.ObjectVar (nautobot.extras.jobs.ObjectVar)" href="#nautobot.apps.jobs.ObjectVar">ObjectVar</a></code></p>
 
 
         <p>Like ObjectVar, but can represent one or more objects.</p>
@@ -13294,6 +13362,7 @@ from object changes and are not intended to be run from the UI or API like stand
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13349,6 +13418,7 @@ an actual instance of the class.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13380,7 +13450,7 @@ an actual instance of the class.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.ScriptVariable (nautobot.extras.jobs.ScriptVariable)" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
 
 
         <p>A single object within Nautobot.</p>
@@ -13418,7 +13488,7 @@ an actual instance of the class.</p>
                 <code>display_field</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13434,7 +13504,7 @@ an actual instance of the class.</p>
                 <code>query_params</code>
             </td>
             <td>
-                  <code>dict</code>
+                  <code><span title="dict">dict</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13450,7 +13520,7 @@ an actual instance of the class.</p>
                 <code>null_option</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13472,6 +13542,7 @@ an actual instance of the class.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13503,7 +13574,7 @@ an actual instance of the class.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code>Exception</code></p>
+              Bases: <code><span title="Exception">Exception</span></code></p>
 
 
         <p>Celery task failed for some reason.</p>
@@ -13514,6 +13585,7 @@ an actual instance of the class.</p>
 
 
 
+
     </div>
 
 </div>
@@ -13542,6 +13614,7 @@ an actual instance of the class.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13565,6 +13638,7 @@ an actual instance of the class.</p>
 
         <p>Render the variable as a Django form field.</p>
 
+
     </div>
 
 </div>
@@ -13590,7 +13664,7 @@ an actual instance of the class.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.ScriptVariable (nautobot.extras.jobs.ScriptVariable)" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
 
 
         <p>Character string representation. Can enforce minimum/maximum length and/or regex validation.</p>
@@ -13603,6 +13677,7 @@ an actual instance of the class.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13634,7 +13709,7 @@ an actual instance of the class.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.jobs.ScriptVariable (nautobot.extras.jobs.ScriptVariable)" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
 
 
         <p>Free-form text data. Renders as a <code>&lt;textarea&gt;</code>.</p>
@@ -13647,6 +13722,7 @@ an actual instance of the class.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13712,7 +13788,7 @@ an actual instance of the class.</p>
                 <code>may_reload_jobs</code>
             </td>
             <td>
-                  <code>bool</code>
+                  <code><span title="bool">bool</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13754,7 +13830,7 @@ an actual instance of the class.</p>
       <tbody>
           <tr class="doc-section-item">
 <td><code>result</code></td>            <td>
-                  <code>tuple[bool, <span title="django.db.models.query.QuerySet">QuerySet</span>]</code>
+                  <code><span title="tuple">tuple</span>[<span title="bool">bool</span>, <span title="django.db.models.query.QuerySet">QuerySet</span>]</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13765,6 +13841,7 @@ an actual instance of the class.</p>
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -13800,7 +13877,7 @@ an actual instance of the class.</p>
                 <code>reload</code>
             </td>
             <td>
-                  <code>bool</code>
+                  <code><span title="bool">bool</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13815,6 +13892,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -13849,7 +13927,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
                 <code>reload</code>
             </td>
             <td>
-                  <code>bool</code>
+                  <code><span title="bool">bool</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13875,7 +13953,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>dict</code>
+                  <code><span title="dict">dict</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13886,6 +13964,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -13903,6 +13982,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
 
         <p>Returns True if the given object is a Job subclass.</p>
 
+
     </div>
 
 </div>
@@ -13920,6 +14000,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
 
         <p>Returns True if the object is a ScriptVariable instance.</p>
 
+
     </div>
 
 </div>
@@ -13937,6 +14018,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
 
         <p>Method to register jobs - with Celery in Nautobot 2.0 through 2.2.2, with Nautobot itself in 2.2.3 and later.</p>
 
+
     </div>
 
 </div>