Skip to content

Commit 7bdd78f

Browse files
Add Datastore trigger to Workflow Automation public API (#2853)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> d3f059d
1 parent 8fcc476 commit 7bdd78f

File tree

8 files changed

+111
-3
lines changed

8 files changed

+111
-3
lines changed

_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5737,6 +5737,20 @@ datadog\_api\_client.v2.model.datastore\_primary\_key\_generation\_strategy modu
57375737
:members:
57385738
:show-inheritance:
57395739

5740+
datadog\_api\_client.v2.model.datastore\_trigger module
5741+
-------------------------------------------------------
5742+
5743+
.. automodule:: datadog_api_client.v2.model.datastore_trigger
5744+
:members:
5745+
:show-inheritance:
5746+
5747+
datadog\_api\_client.v2.model.datastore\_trigger\_wrapper module
5748+
----------------------------------------------------------------
5749+
5750+
.. automodule:: datadog_api_client.v2.model.datastore_trigger_wrapper
5751+
:members:
5752+
:show-inheritance:
5753+
57405754
datadog\_api\_client.v2.model.delete\_app\_response module
57415755
----------------------------------------------------------
57425756

datadog_api_client.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3160,6 +3160,8 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
31603160
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_item_conflict_mode">datadog_api_client.v2.model.datastore_item_conflict_mode module</a></li>
31613161
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_items_data_type">datadog_api_client.v2.model.datastore_items_data_type module</a></li>
31623162
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_primary_key_generation_strategy">datadog_api_client.v2.model.datastore_primary_key_generation_strategy module</a></li>
3163+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_trigger">datadog_api_client.v2.model.datastore_trigger module</a></li>
3164+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_trigger_wrapper">datadog_api_client.v2.model.datastore_trigger_wrapper module</a></li>
31633165
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.delete_app_response">datadog_api_client.v2.model.delete_app_response module</a></li>
31643166
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.delete_app_response_data">datadog_api_client.v2.model.delete_app_response_data module</a></li>
31653167
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.delete_apps_datastore_item_request">datadog_api_client.v2.model.delete_apps_datastore_item_request module</a></li>

datadog_api_client.v2.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5232,6 +5232,14 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
52325232
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.datastore_primary_key_generation_strategy.DatastorePrimaryKeyGenerationStrategy"><code class="docutils literal notranslate"><span class="pre">DatastorePrimaryKeyGenerationStrategy</span></code></a></li>
52335233
</ul>
52345234
</li>
5235+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_trigger">datadog_api_client.v2.model.datastore_trigger module</a><ul>
5236+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.datastore_trigger.DatastoreTrigger"><code class="docutils literal notranslate"><span class="pre">DatastoreTrigger</span></code></a></li>
5237+
</ul>
5238+
</li>
5239+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_trigger_wrapper">datadog_api_client.v2.model.datastore_trigger_wrapper module</a><ul>
5240+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.datastore_trigger_wrapper.DatastoreTriggerWrapper"><code class="docutils literal notranslate"><span class="pre">DatastoreTriggerWrapper</span></code></a></li>
5241+
</ul>
5242+
</li>
52355243
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.delete_app_response">datadog_api_client.v2.model.delete_app_response module</a><ul>
52365244
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.delete_app_response.DeleteAppResponse"><code class="docutils literal notranslate"><span class="pre">DeleteAppResponse</span></code></a></li>
52375245
</ul>

datadog_api_client.v2.model.html

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5622,6 +5622,18 @@
56225622
</li></ul>
56235623
</nav>
56245624
</li>
5625+
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.datastore_trigger" class="md-nav__link">datadog_api_client.v2.model.datastore_trigger module</a><nav class="md-nav">
5626+
<ul class="md-nav__list">
5627+
<li class="md-nav__item"><a href="#datadog_api_client.v2.model.datastore_trigger.DatastoreTrigger" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DatastoreTrigger</span></code></a>
5628+
</li></ul>
5629+
</nav>
5630+
</li>
5631+
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.datastore_trigger_wrapper" class="md-nav__link">datadog_api_client.v2.model.datastore_trigger_wrapper module</a><nav class="md-nav">
5632+
<ul class="md-nav__list">
5633+
<li class="md-nav__item"><a href="#datadog_api_client.v2.model.datastore_trigger_wrapper.DatastoreTriggerWrapper" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DatastoreTriggerWrapper</span></code></a>
5634+
</li></ul>
5635+
</nav>
5636+
</li>
56255637
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.delete_app_response" class="md-nav__link">datadog_api_client.v2.model.delete_app_response module</a><nav class="md-nav">
56265638
<ul class="md-nav__list">
56275639
<li class="md-nav__item"><a href="#datadog_api_client.v2.model.delete_app_response.DeleteAppResponse" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DeleteAppResponse</span></code></a>
@@ -39338,6 +39350,45 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
3933839350
</dl>
3933939351
</dd></dl>
3934039352
</section>
39353+
<section id="module-datadog_api_client.v2.model.datastore_trigger">
39354+
<span id="datadog-api-client-v2-model-datastore-trigger-module"></span><h2 id="module-datadog_api_client.v2.model.datastore_trigger">datadog_api_client.v2.model.datastore_trigger module<a class="headerlink" href="#module-datadog_api_client.v2.model.datastore_trigger" title="Link to this heading">¶</a></h2>
39355+
<dl class="py class">
39356+
<dt class="sig sig-object py" id="datadog_api_client.v2.model.datastore_trigger.DatastoreTrigger">
39357+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DatastoreTrigger</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.datastore_trigger.DatastoreTrigger" title="Link to this definition">¶</a></dt>
39358+
<dt class="sig sig-object py">
39359+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DatastoreTrigger</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>
39360+
<dt class="sig sig-object py">
39361+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DatastoreTrigger</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>
39362+
<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>
39363+
<p>Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.</p>
39364+
<dl class="field-list simple">
39365+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
39366+
<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>
39367+
</dd>
39368+
</dl>
39369+
</dd></dl>
39370+
</section>
39371+
<section id="module-datadog_api_client.v2.model.datastore_trigger_wrapper">
39372+
<span id="datadog-api-client-v2-model-datastore-trigger-wrapper-module"></span><h2 id="module-datadog_api_client.v2.model.datastore_trigger_wrapper">datadog_api_client.v2.model.datastore_trigger_wrapper module<a class="headerlink" href="#module-datadog_api_client.v2.model.datastore_trigger_wrapper" title="Link to this heading">¶</a></h2>
39373+
<dl class="py class">
39374+
<dt class="sig sig-object py" id="datadog_api_client.v2.model.datastore_trigger_wrapper.DatastoreTriggerWrapper">
39375+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DatastoreTriggerWrapper</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.datastore_trigger_wrapper.DatastoreTriggerWrapper" title="Link to this definition">¶</a></dt>
39376+
<dt class="sig sig-object py">
39377+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DatastoreTriggerWrapper</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>
39378+
<dt class="sig sig-object py">
39379+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DatastoreTriggerWrapper</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>
39380+
<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>
39381+
<p>Schema for a Datastore-based trigger.</p>
39382+
<dl class="field-list simple">
39383+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
39384+
<dd class="field-odd"><ul class="simple">
39385+
<li><p><strong>datastore_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.datastore_trigger.DatastoreTrigger" title="datadog_api_client.v2.model.datastore_trigger.DatastoreTrigger"><em>DatastoreTrigger</em></a>) – Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.</p></li>
39386+
<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>
39387+
</ul>
39388+
</dd>
39389+
</dl>
39390+
</dd></dl>
39391+
</section>
3934139392
<section id="module-datadog_api_client.v2.model.delete_app_response">
3934239393
<span id="datadog-api-client-v2-model-delete-app-response-module"></span><h2 id="module-datadog_api_client.v2.model.delete_app_response">datadog_api_client.v2.model.delete_app_response module<a class="headerlink" href="#module-datadog_api_client.v2.model.delete_app_response" title="Link to this heading">¶</a></h2>
3934339394
<dl class="py class">
@@ -91412,6 +91463,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
9141291463
<li><p><strong>case_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.case_trigger.CaseTrigger" title="datadog_api_client.v2.model.case_trigger.CaseTrigger"><em>CaseTrigger</em></a>) – Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.</p></li>
9141391464
<li><p><strong>change_event_trigger</strong> (<em>dict</em>) – Trigger a workflow from a Change Event.</p></li>
9141491465
<li><p><strong>database_monitoring_trigger</strong> (<em>dict</em>) – Trigger a workflow from Database Monitoring.</p></li>
91466+
<li><p><strong>datastore_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.datastore_trigger.DatastoreTrigger" title="datadog_api_client.v2.model.datastore_trigger.DatastoreTrigger"><em>DatastoreTrigger</em></a>) – Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.</p></li>
9141591467
<li><p><strong>dashboard_trigger</strong> (<em>dict</em>) – Trigger a workflow from a Dashboard.</p></li>
9141691468
<li><p><strong>github_webhook_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.github_webhook_trigger.GithubWebhookTrigger" title="datadog_api_client.v2.model.github_webhook_trigger.GithubWebhookTrigger"><em>GithubWebhookTrigger</em></a>) – Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a <cite>webhookSecret</cite>. In your GitHub Webhook Settings, set the Payload URL to “base_url”/api/v2/workflows/”workflow_id”/webhook?orgId=”org_id”, select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.</p></li>
9141791469
<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>

genindex.html

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16221,6 +16221,20 @@ <h2 id="D">D</h2>
1622116221

1622216222
<ul>
1622316223
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_primary_key_generation_strategy">module</a>
16224+
</li>
16225+
</ul></li>
16226+
<li>
16227+
datadog_api_client.v2.model.datastore_trigger
16228+
16229+
<ul>
16230+
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_trigger">module</a>
16231+
</li>
16232+
</ul></li>
16233+
<li>
16234+
datadog_api_client.v2.model.datastore_trigger_wrapper
16235+
16236+
<ul>
16237+
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_trigger_wrapper">module</a>
1622416238
</li>
1622516239
</ul></li>
1622616240
<li>
@@ -18281,15 +18295,15 @@ <h2 id="D">D</h2>
1828118295
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.full_custom_framework_data_attributes">module</a>
1828218296
</li>
1828318297
</ul></li>
18298+
</ul></td>
18299+
<td style="width: 33%; vertical-align: top;"><ul>
1828418300
<li>
1828518301
datadog_api_client.v2.model.gcp_credentials
1828618302

1828718303
<ul>
1828818304
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.gcp_credentials">module</a>
1828918305
</li>
1829018306
</ul></li>
18291-
</ul></td>
18292-
<td style="width: 33%; vertical-align: top;"><ul>
1829318307
<li>
1829418308
datadog_api_client.v2.model.gcp_credentials_update
1829518309

@@ -32846,6 +32860,10 @@ <h2 id="D">D</h2>
3284632860
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.datastore_items_data_type.DatastoreItemsDataType">DatastoreItemsDataType (class in datadog_api_client.v2.model.datastore_items_data_type)</a>
3284732861
</li>
3284832862
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.datastore_primary_key_generation_strategy.DatastorePrimaryKeyGenerationStrategy">DatastorePrimaryKeyGenerationStrategy (class in datadog_api_client.v2.model.datastore_primary_key_generation_strategy)</a>
32863+
</li>
32864+
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.datastore_trigger.DatastoreTrigger">DatastoreTrigger (class in datadog_api_client.v2.model.datastore_trigger)</a>
32865+
</li>
32866+
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.datastore_trigger_wrapper.DatastoreTriggerWrapper">DatastoreTriggerWrapper (class in datadog_api_client.v2.model.datastore_trigger_wrapper)</a>
3284932867
</li>
3285032868
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.data_transform.DataTransform">DataTransform (class in datadog_api_client.v2.model.data_transform)</a>
3285132869
</li>
@@ -40258,6 +40276,10 @@ <h2 id="M">M</h2>
4025840276
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_items_data_type">datadog_api_client.v2.model.datastore_items_data_type</a>
4025940277
</li>
4026040278
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_primary_key_generation_strategy">datadog_api_client.v2.model.datastore_primary_key_generation_strategy</a>
40279+
</li>
40280+
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_trigger">datadog_api_client.v2.model.datastore_trigger</a>
40281+
</li>
40282+
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_trigger_wrapper">datadog_api_client.v2.model.datastore_trigger_wrapper</a>
4026140283
</li>
4026240284
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.delete_app_response">datadog_api_client.v2.model.delete_app_response</a>
4026340285
</li>

objects.inv

22 Bytes
Binary file not shown.

py-modindex.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10140,6 +10140,16 @@ <h1>Python Module Index</h1>
1014010140
<td>&#160;&#160;&#160;
1014110141
<a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_primary_key_generation_strategy"><code class="xref">datadog_api_client.v2.model.datastore_primary_key_generation_strategy</code></a></td><td>
1014210142
<em></em></td></tr>
10143+
<tr class="cg-1">
10144+
<td></td>
10145+
<td>&#160;&#160;&#160;
10146+
<a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_trigger"><code class="xref">datadog_api_client.v2.model.datastore_trigger</code></a></td><td>
10147+
<em></em></td></tr>
10148+
<tr class="cg-1">
10149+
<td></td>
10150+
<td>&#160;&#160;&#160;
10151+
<a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.datastore_trigger_wrapper"><code class="xref">datadog_api_client.v2.model.datastore_trigger_wrapper</code></a></td><td>
10152+
<em></em></td></tr>
1014310153
<tr class="cg-1">
1014410154
<td></td>
1014510155
<td>&#160;&#160;&#160;

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)