Skip to content

Commit 46d9217

Browse files
Complete Observability Pipelines API (#2531)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 8e48eeb
1 parent 9f8d25c commit 46d9217

9 files changed

Lines changed: 9806 additions & 633 deletions

_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 1168 additions & 118 deletions
Large diffs are not rendered by default.

datadog_api_client.html

Lines changed: 152 additions & 2 deletions
Large diffs are not rendered by default.

datadog_api_client.v2.api.html

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1611,7 +1611,11 @@
16111611
</li>
16121612
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.observability_pipelines_api.ObservabilityPipelinesApi.get_pipeline" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ObservabilityPipelinesApi.get_pipeline()</span></code></a>
16131613
</li>
1614+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.observability_pipelines_api.ObservabilityPipelinesApi.list_pipelines" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ObservabilityPipelinesApi.list_pipelines()</span></code></a>
1615+
</li>
16141616
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.observability_pipelines_api.ObservabilityPipelinesApi.update_pipeline" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ObservabilityPipelinesApi.update_pipeline()</span></code></a>
1617+
</li>
1618+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.observability_pipelines_api.ObservabilityPipelinesApi.validate_pipeline" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ObservabilityPipelinesApi.validate_pipeline()</span></code></a>
16151619
</li></ul>
16161620
</nav>
16171621
</li></ul>
@@ -7276,7 +7280,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
72767280
<p>Observability Pipelines allows you to collect and process logs within your own infrastructure, and then route them to downstream integrations.</p>
72777281
<dl class="py method">
72787282
<dt class="sig sig-object py" id="datadog_api_client.v2.api.observability_pipelines_api.ObservabilityPipelinesApi.create_pipeline">
7279-
<span class="sig-name descname"><span class="pre">create_pipeline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">body</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.v2.model.html#datadog_api_client.v2.model.observability_pipeline_create_request.ObservabilityPipelineCreateRequest" title="datadog_api_client.v2.model.observability_pipeline_create_request.ObservabilityPipelineCreateRequest"><span class="pre">ObservabilityPipelineCreateRequest</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline.ObservabilityPipeline" title="datadog_api_client.v2.model.observability_pipeline.ObservabilityPipeline"><span class="pre">ObservabilityPipeline</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.observability_pipelines_api.ObservabilityPipelinesApi.create_pipeline" title="Link to this definition">¶</a></dt>
7283+
<span class="sig-name descname"><span class="pre">create_pipeline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">body</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.v2.model.html#datadog_api_client.v2.model.observability_pipeline_spec.ObservabilityPipelineSpec" title="datadog_api_client.v2.model.observability_pipeline_spec.ObservabilityPipelineSpec"><span class="pre">ObservabilityPipelineSpec</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline.ObservabilityPipeline" title="datadog_api_client.v2.model.observability_pipeline.ObservabilityPipeline"><span class="pre">ObservabilityPipeline</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.observability_pipelines_api.ObservabilityPipelinesApi.create_pipeline" title="Link to this definition">¶</a></dt>
72807284
<dd><p>Create a new pipeline.</p>
72817285
<p>Create a new pipeline.</p>
72827286
<dl class="field-list simple">
@@ -7314,6 +7318,23 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
73147318
</dl>
73157319
</dd></dl>
73167320
<dl class="py method">
7321+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.observability_pipelines_api.ObservabilityPipelinesApi.list_pipelines">
7322+
<span class="sig-name descname"><span class="pre">list_pipelines</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page_number</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.list_pipelines_response.ListPipelinesResponse" title="datadog_api_client.v2.model.list_pipelines_response.ListPipelinesResponse"><span class="pre">ListPipelinesResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.observability_pipelines_api.ObservabilityPipelinesApi.list_pipelines" title="Link to this definition">¶</a></dt>
7323+
<dd><p>List pipelines.</p>
7324+
<p>Retrieve a list of pipelines.</p>
7325+
<dl class="field-list simple">
7326+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7327+
<dd class="field-odd"><ul class="simple">
7328+
<li><p><strong>page_size</strong> (<em>int</em><em>, </em><em>optional</em>) – Size for a given page. The maximum allowed value is 100.</p></li>
7329+
<li><p><strong>page_number</strong> (<em>int</em><em>, </em><em>optional</em>) – Specific page number to return.</p></li>
7330+
</ul>
7331+
</dd>
7332+
<dt class="field-even">Return type<span class="colon">:</span></dt>
7333+
<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.list_pipelines_response.ListPipelinesResponse" title="datadog_api_client.v2.model.list_pipelines_response.ListPipelinesResponse">ListPipelinesResponse</a></p>
7334+
</dd>
7335+
</dl>
7336+
</dd></dl>
7337+
<dl class="py method">
73177338
<dt class="sig sig-object py" id="datadog_api_client.v2.api.observability_pipelines_api.ObservabilityPipelinesApi.update_pipeline">
73187339
<span class="sig-name descname"><span class="pre">update_pipeline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pipeline_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</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.v2.model.html#datadog_api_client.v2.model.observability_pipeline.ObservabilityPipeline" title="datadog_api_client.v2.model.observability_pipeline.ObservabilityPipeline"><span class="pre">ObservabilityPipeline</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline.ObservabilityPipeline" title="datadog_api_client.v2.model.observability_pipeline.ObservabilityPipeline"><span class="pre">ObservabilityPipeline</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.observability_pipelines_api.ObservabilityPipelinesApi.update_pipeline" title="Link to this definition">¶</a></dt>
73197340
<dd><p>Update a pipeline.</p>
@@ -7327,6 +7348,18 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
73277348
</dd>
73287349
</dl>
73297350
</dd></dl>
7351+
<dl class="py method">
7352+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.observability_pipelines_api.ObservabilityPipelinesApi.validate_pipeline">
7353+
<span class="sig-name descname"><span class="pre">validate_pipeline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">body</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.v2.model.html#datadog_api_client.v2.model.observability_pipeline_spec.ObservabilityPipelineSpec" title="datadog_api_client.v2.model.observability_pipeline_spec.ObservabilityPipelineSpec"><span class="pre">ObservabilityPipelineSpec</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.validation_response.ValidationResponse" title="datadog_api_client.v2.model.validation_response.ValidationResponse"><span class="pre">ValidationResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.observability_pipelines_api.ObservabilityPipelinesApi.validate_pipeline" title="Link to this definition">¶</a></dt>
7354+
<dd><p>Validate an observability pipeline.</p>
7355+
<p>Validates a pipeline configuration without creating or updating any resources.
7356+
Returns a list of validation errors, if any.</p>
7357+
<dl class="field-list simple">
7358+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
7359+
<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.validation_response.ValidationResponse" title="datadog_api_client.v2.model.validation_response.ValidationResponse">ValidationResponse</a></p>
7360+
</dd>
7361+
</dl>
7362+
</dd></dl>
73307363
</dd></dl>
73317364
</section>
73327365
<section id="module-datadog_api_client.v2.api.okta_integration_api">

0 commit comments

Comments
 (0)