Add On-Call Trigger to Workflow Automation Public API (#3121)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> e0bc0de

Author: api-clients-generation-pipeline[bot]

_sources/datadog_api_client.v2.model.rst.txt

@@ -18295,6 +18295,20 @@ datadog\_api\_client.v2.model.on\_call\_phone\_notification\_rule\_settings modu
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.on\_call\_trigger module
+------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.on_call_trigger
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.on\_call\_trigger\_wrapper module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.on_call_trigger_wrapper
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.on\_demand\_concurrency\_cap module
 -----------------------------------------------------------------
 

datadog_api_client.html

@@ -5176,6 +5176,8 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.on_call_page_target_type">datadog_api_client.v2.model.on_call_page_target_type module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.on_call_phone_notification_rule_method">datadog_api_client.v2.model.on_call_phone_notification_rule_method module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.on_call_phone_notification_rule_settings">datadog_api_client.v2.model.on_call_phone_notification_rule_settings module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.on_call_trigger">datadog_api_client.v2.model.on_call_trigger module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.on_call_trigger_wrapper">datadog_api_client.v2.model.on_call_trigger_wrapper module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.on_demand_concurrency_cap">datadog_api_client.v2.model.on_demand_concurrency_cap module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.on_demand_concurrency_cap_attributes">datadog_api_client.v2.model.on_demand_concurrency_cap_attributes module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.on_demand_concurrency_cap_response">datadog_api_client.v2.model.on_demand_concurrency_cap_response module</a></li>

datadog_api_client.v2.html

@@ -12925,6 +12925,14 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.on_call_phone_notification_rule_settings.OnCallPhoneNotificationRuleSettings"><code class="docutils literal notranslate"><span class="pre">OnCallPhoneNotificationRuleSettings</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.on_call_trigger">datadog_api_client.v2.model.on_call_trigger module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.on_call_trigger.OnCallTrigger"><code class="docutils literal notranslate"><span class="pre">OnCallTrigger</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.on_call_trigger_wrapper">datadog_api_client.v2.model.on_call_trigger_wrapper module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.on_call_trigger_wrapper.OnCallTriggerWrapper"><code class="docutils literal notranslate"><span class="pre">OnCallTriggerWrapper</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.on_demand_concurrency_cap">datadog_api_client.v2.model.on_demand_concurrency_cap module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.on_demand_concurrency_cap.OnDemandConcurrencyCap"><code class="docutils literal notranslate"><span class="pre">OnDemandConcurrencyCap</span></code></a></li>
 </ul>

datadog_api_client.v2.model.html

@@ -16651,6 +16651,18 @@
         </li></ul>
             </nav>
         </li>
+        <li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.on_call_trigger" class="md-nav__link">datadog_api_client.v2.model.on_call_trigger module</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.model.on_call_trigger.OnCallTrigger" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">OnCallTrigger</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
+        <li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.on_call_trigger_wrapper" class="md-nav__link">datadog_api_client.v2.model.on_call_trigger_wrapper module</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.model.on_call_trigger_wrapper.OnCallTriggerWrapper" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">OnCallTriggerWrapper</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
         <li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.on_demand_concurrency_cap" class="md-nav__link">datadog_api_client.v2.model.on_demand_concurrency_cap module</a><nav class="md-nav">
               <ul class="md-nav__list">
         <li class="md-nav__item"><a href="#datadog_api_client.v2.model.on_demand_concurrency_cap.OnDemandConcurrencyCap" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">OnDemandConcurrencyCap</span></code></a>
@@ -87675,6 +87687,45 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 </dl>
 </dd></dl>
 </section>
+<section id="module-datadog_api_client.v2.model.on_call_trigger">
+<span id="datadog-api-client-v2-model-on-call-trigger-module"></span><h2 id="module-datadog_api_client.v2.model.on_call_trigger">datadog_api_client.v2.model.on_call_trigger module<a class="headerlink" href="#module-datadog_api_client.v2.model.on_call_trigger" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="datadog_api_client.v2.model.on_call_trigger.OnCallTrigger">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">OnCallTrigger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v2.model.on_call_trigger.OnCallTrigger" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">OnCallTrigger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelComposed" title="datadog_api_client.model_utils.ModelComposed"><span class="pre">ModelComposed</span></a></span></em><span class="sig-paren">)</span></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">OnCallTrigger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
+<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelNormal" title="datadog_api_client.model_utils.ModelNormal"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelNormal</span></code></a></p>
+<p>Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>rate_limit</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.trigger_rate_limit.TriggerRateLimit" title="datadog_api_client.v2.model.trigger_rate_limit.TriggerRateLimit"><em>TriggerRateLimit</em></a><em>, </em><em>optional</em>) – Defines a rate limit for a trigger.</p>
+</dd>
+</dl>
+</dd></dl>
+</section>
+<section id="module-datadog_api_client.v2.model.on_call_trigger_wrapper">
+<span id="datadog-api-client-v2-model-on-call-trigger-wrapper-module"></span><h2 id="module-datadog_api_client.v2.model.on_call_trigger_wrapper">datadog_api_client.v2.model.on_call_trigger_wrapper module<a class="headerlink" href="#module-datadog_api_client.v2.model.on_call_trigger_wrapper" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="datadog_api_client.v2.model.on_call_trigger_wrapper.OnCallTriggerWrapper">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">OnCallTriggerWrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v2.model.on_call_trigger_wrapper.OnCallTriggerWrapper" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">OnCallTriggerWrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelComposed" title="datadog_api_client.model_utils.ModelComposed"><span class="pre">ModelComposed</span></a></span></em><span class="sig-paren">)</span></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">OnCallTriggerWrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
+<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelNormal" title="datadog_api_client.model_utils.ModelNormal"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelNormal</span></code></a></p>
+<p>Schema for an On-Call-based trigger.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>on_call_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.on_call_trigger.OnCallTrigger" title="datadog_api_client.v2.model.on_call_trigger.OnCallTrigger"><em>OnCallTrigger</em></a>) – Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.</p></li>
+<li><p><strong>start_step_names</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – A list of steps that run first after a trigger fires.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+</section>
 <section id="module-datadog_api_client.v2.model.on_demand_concurrency_cap">
 <span id="datadog-api-client-v2-model-on-demand-concurrency-cap-module"></span><h2 id="module-datadog_api_client.v2.model.on_demand_concurrency_cap">datadog_api_client.v2.model.on_demand_concurrency_cap module<a class="headerlink" href="#module-datadog_api_client.v2.model.on_demand_concurrency_cap" title="Link to this heading">¶</a></h2>
 <dl class="py class">
@@ -117663,6 +117714,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <li><p><strong>incident_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.incident_trigger.IncidentTrigger" title="datadog_api_client.v2.model.incident_trigger.IncidentTrigger"><em>IncidentTrigger</em></a>) – Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.</p></li>
 <li><p><strong>monitor_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.monitor_trigger.MonitorTrigger" title="datadog_api_client.v2.model.monitor_trigger.MonitorTrigger"><em>MonitorTrigger</em></a>) – Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.</p></li>
 <li><p><strong>notebook_trigger</strong> (<em>dict</em>) – Trigger a workflow from a Notebook.</p></li>
+<li><p><strong>on_call_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.on_call_trigger.OnCallTrigger" title="datadog_api_client.v2.model.on_call_trigger.OnCallTrigger"><em>OnCallTrigger</em></a>) – Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.</p></li>
 <li><p><strong>schedule_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.schedule_trigger.ScheduleTrigger" title="datadog_api_client.v2.model.schedule_trigger.ScheduleTrigger"><em>ScheduleTrigger</em></a>) – Trigger a workflow from a Schedule. The workflow must be published.</p></li>
 <li><p><strong>security_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.security_trigger.SecurityTrigger" title="datadog_api_client.v2.model.security_trigger.SecurityTrigger"><em>SecurityTrigger</em></a>) – Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.</p></li>
 <li><p><strong>self_service_trigger</strong> (<em>dict</em>) – Trigger a workflow from Self Service.</p></li>