Skip to content

Commit 5fbbee2

Browse files
Adding datastream to Open Search destination and adding Auth Strategy for Observability Pipeline API (#3096)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> cb2b2ac
1 parent 0355d5e commit 5fbbee2

File tree

8 files changed

+61
-4
lines changed

8 files changed

+61
-4
lines changed

_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16909,6 +16909,13 @@ datadog\_api\_client.v2.model.observability\_pipeline\_open\_search\_destination
1690916909
:members:
1691016910
:show-inheritance:
1691116911

16912+
datadog\_api\_client.v2.model.observability\_pipeline\_open\_search\_destination\_data\_stream module
16913+
-----------------------------------------------------------------------------------------------------
16914+
16915+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream
16916+
:members:
16917+
:show-inheritance:
16918+
1691216919
datadog\_api\_client.v2.model.observability\_pipeline\_open\_search\_destination\_type module
1691316920
---------------------------------------------------------------------------------------------
1691416921

datadog_api_client.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4976,6 +4976,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
49764976
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor_type">datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor_type module</a></li>
49774977
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_library">datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_library module</a></li>
49784978
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination">datadog_api_client.v2.model.observability_pipeline_open_search_destination module</a></li>
4979+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream">datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream module</a></li>
49794980
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_type">datadog_api_client.v2.model.observability_pipeline_open_search_destination_type module</a></li>
49804981
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_opentelemetry_source">datadog_api_client.v2.model.observability_pipeline_opentelemetry_source module</a></li>
49814982
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_opentelemetry_source_type">datadog_api_client.v2.model.observability_pipeline_opentelemetry_source_type module</a></li>

datadog_api_client.v2.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12101,6 +12101,10 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
1210112101
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline_open_search_destination.ObservabilityPipelineOpenSearchDestination"><code class="docutils literal notranslate"><span class="pre">ObservabilityPipelineOpenSearchDestination</span></code></a></li>
1210212102
</ul>
1210312103
</li>
12104+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream">datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream module</a><ul>
12105+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream.ObservabilityPipelineOpenSearchDestinationDataStream"><code class="docutils literal notranslate"><span class="pre">ObservabilityPipelineOpenSearchDestinationDataStream</span></code></a></li>
12106+
</ul>
12107+
</li>
1210412108
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_type">datadog_api_client.v2.model.observability_pipeline_open_search_destination_type module</a><ul>
1210512109
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline_open_search_destination_type.ObservabilityPipelineOpenSearchDestinationType"><code class="docutils literal notranslate"><span class="pre">ObservabilityPipelineOpenSearchDestinationType</span></code></a></li>
1210612110
</ul>

datadog_api_client.v2.model.html

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15463,6 +15463,12 @@
1546315463
</li></ul>
1546415464
</nav>
1546515465
</li>
15466+
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream" class="md-nav__link">datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream module</a><nav class="md-nav">
15467+
<ul class="md-nav__list">
15468+
<li class="md-nav__item"><a href="#datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream.ObservabilityPipelineOpenSearchDestinationDataStream" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ObservabilityPipelineOpenSearchDestinationDataStream</span></code></a>
15469+
</li></ul>
15470+
</nav>
15471+
</li>
1546615472
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_type" class="md-nav__link">datadog_api_client.v2.model.observability_pipeline_open_search_destination_type module</a><nav class="md-nav">
1546715473
<ul class="md-nav__list">
1546815474
<li class="md-nav__item"><a href="#datadog_api_client.v2.model.observability_pipeline_open_search_destination_type.ObservabilityPipelineOpenSearchDestinationType" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ObservabilityPipelineOpenSearchDestinationType</span></code></a>
@@ -81374,7 +81380,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
8137481380
<dl class="field-list simple">
8137581381
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
8137681382
<dd class="field-odd"><ul class="simple">
81377-
<li><p><strong>value</strong> (<em>str</em>) – Must be one of [“none”, “basic”, “bearer”].</p></li>
81383+
<li><p><strong>value</strong> (<em>str</em>) – Must be one of [“none”, “basic”, “bearer”, “custom”].</p></li>
8137881384
<li><p><strong>_check_type</strong> (<em>bool</em>) – If True, values for parameters in openapi_types
8137981385
will be type checked and a TypeError will be raised if the wrong type is input.
8138081386
Defaults to True.</p></li>
@@ -82227,6 +82233,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
8222782233
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
8222882234
<dd class="field-odd"><ul class="simple">
8222982235
<li><p><strong>bulk_index</strong> (<em>str</em><em>, </em><em>optional</em>) – The index to write logs to.</p></li>
82236+
<li><p><strong>data_stream</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream.ObservabilityPipelineOpenSearchDestinationDataStream" title="datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream.ObservabilityPipelineOpenSearchDestinationDataStream"><em>ObservabilityPipelineOpenSearchDestinationDataStream</em></a><em>, </em><em>optional</em>) – Configuration options for writing to OpenSearch Data Streams instead of a fixed index.</p></li>
8223082237
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this component.</p></li>
8223182238
<li><p><strong>inputs</strong> (<em>[</em><em>str</em><em>]</em>) – A list of component IDs whose output is used as the <code class="docutils literal notranslate"><span class="pre">input</span></code> for this component.</p></li>
8223282239
<li><p><strong>type</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.observability_pipeline_open_search_destination_type.ObservabilityPipelineOpenSearchDestinationType" title="datadog_api_client.v2.model.observability_pipeline_open_search_destination_type.ObservabilityPipelineOpenSearchDestinationType"><em>ObservabilityPipelineOpenSearchDestinationType</em></a>) – The destination type. The value should always be <code class="docutils literal notranslate"><span class="pre">opensearch</span></code>.</p></li>
@@ -82235,6 +82242,28 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
8223582242
</dl>
8223682243
</dd></dl>
8223782244
</section>
82245+
<section id="module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream">
82246+
<span id="datadog-api-client-v2-model-observability-pipeline-open-search-destination-data-stream-module"></span><h2 id="module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream">datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream module<a class="headerlink" href="#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream" title="Link to this heading">¶</a></h2>
82247+
<dl class="py class">
82248+
<dt class="sig sig-object py" id="datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream.ObservabilityPipelineOpenSearchDestinationDataStream">
82249+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ObservabilityPipelineOpenSearchDestinationDataStream</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.observability_pipeline_open_search_destination_data_stream.ObservabilityPipelineOpenSearchDestinationDataStream" title="Link to this definition">¶</a></dt>
82250+
<dt class="sig sig-object py">
82251+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ObservabilityPipelineOpenSearchDestinationDataStream</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>
82252+
<dt class="sig sig-object py">
82253+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ObservabilityPipelineOpenSearchDestinationDataStream</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>
82254+
<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>
82255+
<p>Configuration options for writing to OpenSearch Data Streams instead of a fixed index.</p>
82256+
<dl class="field-list simple">
82257+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
82258+
<dd class="field-odd"><ul class="simple">
82259+
<li><p><strong>dataset</strong> (<em>str</em><em>, </em><em>optional</em>) – The data stream dataset for your logs. This groups logs by their source or application.</p></li>
82260+
<li><p><strong>dtype</strong> (<em>str</em><em>, </em><em>optional</em>) – The data stream type for your logs. This determines how logs are categorized within the data stream.</p></li>
82261+
<li><p><strong>namespace</strong> (<em>str</em><em>, </em><em>optional</em>) – The data stream namespace for your logs. This separates logs into different environments or domains.</p></li>
82262+
</ul>
82263+
</dd>
82264+
</dl>
82265+
</dd></dl>
82266+
</section>
8223882267
<section id="module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_type">
8223982268
<span id="datadog-api-client-v2-model-observability-pipeline-open-search-destination-type-module"></span><h2 id="module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_type">datadog_api_client.v2.model.observability_pipeline_open_search_destination_type module<a class="headerlink" href="#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_type" title="Link to this heading">¶</a></h2>
8224082269
<dl class="py class">

genindex.html

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28364,6 +28364,13 @@ <h2 id="D">D</h2>
2836428364

2836528365
<ul>
2836628366
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination">module</a>
28367+
</li>
28368+
</ul></li>
28369+
<li>
28370+
datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream
28371+
28372+
<ul>
28373+
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream">module</a>
2836728374
</li>
2836828375
</ul></li>
2836928376
<li>
@@ -51085,6 +51092,8 @@ <h2 id="M">M</h2>
5108551092
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_library">datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_library</a>
5108651093
</li>
5108751094
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination">datadog_api_client.v2.model.observability_pipeline_open_search_destination</a>
51095+
</li>
51096+
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream">datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream</a>
5108851097
</li>
5108951098
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_type">datadog_api_client.v2.model.observability_pipeline_open_search_destination_type</a>
5109051099
</li>
@@ -55002,6 +55011,8 @@ <h2 id="O">O</h2>
5500255011
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_library.ObservabilityPipelineOcsfMappingLibrary">ObservabilityPipelineOcsfMappingLibrary (class in datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_library)</a>
5500355012
</li>
5500455013
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline_open_search_destination.ObservabilityPipelineOpenSearchDestination">ObservabilityPipelineOpenSearchDestination (class in datadog_api_client.v2.model.observability_pipeline_open_search_destination)</a>
55014+
</li>
55015+
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream.ObservabilityPipelineOpenSearchDestinationDataStream">ObservabilityPipelineOpenSearchDestinationDataStream (class in datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream)</a>
5500555016
</li>
5500655017
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline_open_search_destination_type.ObservabilityPipelineOpenSearchDestinationType">ObservabilityPipelineOpenSearchDestinationType (class in datadog_api_client.v2.model.observability_pipeline_open_search_destination_type)</a>
5500755018
</li>
@@ -55116,11 +55127,11 @@ <h2 id="O">O</h2>
5511655127
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_all.ObservabilityPipelineSensitiveDataScannerProcessorScopeAll">ObservabilityPipelineSensitiveDataScannerProcessorScopeAll (class in datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_all)</a>
5511755128
</li>
5511855129
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_all_target.ObservabilityPipelineSensitiveDataScannerProcessorScopeAllTarget">ObservabilityPipelineSensitiveDataScannerProcessorScopeAllTarget (class in datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_all_target)</a>
55119-
</li>
55120-
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_exclude.ObservabilityPipelineSensitiveDataScannerProcessorScopeExclude">ObservabilityPipelineSensitiveDataScannerProcessorScopeExclude (class in datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_exclude)</a>
5512155130
</li>
5512255131
</ul></td>
5512355132
<td style="width: 33%; vertical-align: top;"><ul>
55133+
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_exclude.ObservabilityPipelineSensitiveDataScannerProcessorScopeExclude">ObservabilityPipelineSensitiveDataScannerProcessorScopeExclude (class in datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_exclude)</a>
55134+
</li>
5512455135
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_exclude_target.ObservabilityPipelineSensitiveDataScannerProcessorScopeExcludeTarget">ObservabilityPipelineSensitiveDataScannerProcessorScopeExcludeTarget (class in datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_exclude_target)</a>
5512555136
</li>
5512655137
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_include.ObservabilityPipelineSensitiveDataScannerProcessorScopeInclude">ObservabilityPipelineSensitiveDataScannerProcessorScopeInclude (class in datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_include)</a>

objects.inv

12 Bytes
Binary file not shown.

py-modindex.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18457,6 +18457,11 @@ <h1>Python Module Index</h1>
1845718457
<td>&#160;&#160;&#160;
1845818458
<a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination"><code class="xref">datadog_api_client.v2.model.observability_pipeline_open_search_destination</code></a></td><td>
1845918459
<em></em></td></tr>
18460+
<tr class="cg-1">
18461+
<td></td>
18462+
<td>&#160;&#160;&#160;
18463+
<a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream"><code class="xref">datadog_api_client.v2.model.observability_pipeline_open_search_destination_data_stream</code></a></td><td>
18464+
<em></em></td></tr>
1846018465
<tr class="cg-1">
1846118466
<td></td>
1846218467
<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)