Skip to content

Commit 2c933ec

Browse files
Uncomment edit dataset block, add dataset limitations into endpoint descriptions (#2723)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> f9ea2ab
1 parent 548aba8 commit 2c933ec

9 files changed

Lines changed: 164 additions & 7 deletions

_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4841,6 +4841,13 @@ datadog\_api\_client.v2.model.dataset\_response\_single module
48414841
:members:
48424842
:show-inheritance:
48434843

4844+
datadog\_api\_client.v2.model.dataset\_update\_request module
4845+
-------------------------------------------------------------
4846+
4847+
.. automodule:: datadog_api_client.v2.model.dataset_update_request
4848+
:members:
4849+
:show-inheritance:
4850+
48444851
datadog\_api\_client.v2.model.delete\_app\_response module
48454852
----------------------------------------------------------
48464853

datadog_api_client.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3025,6 +3025,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
30253025
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.dataset_create_request">datadog_api_client.v2.model.dataset_create_request module</a></li>
30263026
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.dataset_response_multi">datadog_api_client.v2.model.dataset_response_multi module</a></li>
30273027
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.dataset_response_single">datadog_api_client.v2.model.dataset_response_single module</a></li>
3028+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.dataset_update_request">datadog_api_client.v2.model.dataset_update_request module</a></li>
30283029
<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>
30293030
<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>
30303031
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.delete_apps_request">datadog_api_client.v2.model.delete_apps_request module</a></li>

datadog_api_client.v2.api.html

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1192,6 +1192,8 @@
11921192
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.datasets_api.DatasetsApi.get_all_datasets" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DatasetsApi.get_all_datasets()</span></code></a>
11931193
</li>
11941194
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.datasets_api.DatasetsApi.get_dataset" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DatasetsApi.get_dataset()</span></code></a>
1195+
</li>
1196+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.datasets_api.DatasetsApi.update_dataset" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DatasetsApi.update_dataset()</span></code></a>
11951197
</li></ul>
11961198
</nav>
11971199
</li></ul>
@@ -5065,6 +5067,23 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
50655067
</dd>
50665068
</dl>
50675069
</dd></dl>
5070+
<dl class="py method">
5071+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.datasets_api.DatasetsApi.update_dataset">
5072+
<span class="sig-name descname"><span class="pre">update_dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_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.dataset_update_request.DatasetUpdateRequest" title="datadog_api_client.v2.model.dataset_update_request.DatasetUpdateRequest"><span class="pre">DatasetUpdateRequest</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.dataset_response_single.DatasetResponseSingle" title="datadog_api_client.v2.model.dataset_response_single.DatasetResponseSingle"><span class="pre">DatasetResponseSingle</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.datasets_api.DatasetsApi.update_dataset" title="Link to this definition">¶</a></dt>
5073+
<dd><p>Edit a dataset.</p>
5074+
<p>Edits the dataset associated with the ID.</p>
5075+
<dl class="field-list simple">
5076+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
5077+
<dd class="field-odd"><ul class="simple">
5078+
<li><p><strong>dataset_id</strong> (<em>str</em>) – The ID of a defined dataset.</p></li>
5079+
<li><p><strong>body</strong> (<a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.dataset_update_request.DatasetUpdateRequest" title="datadog_api_client.v2.model.dataset_update_request.DatasetUpdateRequest"><em>DatasetUpdateRequest</em></a>) – Dataset payload</p></li>
5080+
</ul>
5081+
</dd>
5082+
<dt class="field-even">Return type<span class="colon">:</span></dt>
5083+
<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.dataset_response_single.DatasetResponseSingle" title="datadog_api_client.v2.model.dataset_response_single.DatasetResponseSingle">DatasetResponseSingle</a></p>
5084+
</dd>
5085+
</dl>
5086+
</dd></dl>
50685087
</dd></dl>
50695088
</section>
50705089
<section id="module-datadog_api_client.v2.api.domain_allowlist_api">

datadog_api_client.v2.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1149,6 +1149,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
11491149
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.datasets_api.DatasetsApi.delete_dataset"><code class="docutils literal notranslate"><span class="pre">DatasetsApi.delete_dataset()</span></code></a></li>
11501150
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.datasets_api.DatasetsApi.get_all_datasets"><code class="docutils literal notranslate"><span class="pre">DatasetsApi.get_all_datasets()</span></code></a></li>
11511151
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.datasets_api.DatasetsApi.get_dataset"><code class="docutils literal notranslate"><span class="pre">DatasetsApi.get_dataset()</span></code></a></li>
1152+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.datasets_api.DatasetsApi.update_dataset"><code class="docutils literal notranslate"><span class="pre">DatasetsApi.update_dataset()</span></code></a></li>
11521153
</ul>
11531154
</li>
11541155
</ul>
@@ -4634,6 +4635,10 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
46344635
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.dataset_response_single.DatasetResponseSingle"><code class="docutils literal notranslate"><span class="pre">DatasetResponseSingle</span></code></a></li>
46354636
</ul>
46364637
</li>
4638+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.dataset_update_request">datadog_api_client.v2.model.dataset_update_request module</a><ul>
4639+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.dataset_update_request.DatasetUpdateRequest"><code class="docutils literal notranslate"><span class="pre">DatasetUpdateRequest</span></code></a></li>
4640+
</ul>
4641+
</li>
46374642
<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>
46384643
<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>
46394644
</ul>

datadog_api_client.v2.model.html

Lines changed: 111 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4854,6 +4854,12 @@
48544854
</li></ul>
48554855
</nav>
48564856
</li>
4857+
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.dataset_update_request" class="md-nav__link">datadog_api_client.v2.model.dataset_update_request module</a><nav class="md-nav">
4858+
<ul class="md-nav__list">
4859+
<li class="md-nav__item"><a href="#datadog_api_client.v2.model.dataset_update_request.DatasetUpdateRequest" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DatasetUpdateRequest</span></code></a>
4860+
</li></ul>
4861+
</nav>
4862+
</li>
48574863
<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">
48584864
<ul class="md-nav__list">
48594865
<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>
@@ -33055,6 +33061,26 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
3305533061
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Dataset</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>
3305633062
<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>
3305733063
<p>Dataset object.</p>
33064+
<p><strong>Datasets Constraints</strong></p>
33065+
<ul class="simple">
33066+
<li><p><strong>Tag Limit per Dataset</strong> :</p>
33067+
<ul>
33068+
<li><p>Each restricted dataset supports a maximum of 10 key:value pairs per product.</p></li>
33069+
</ul>
33070+
</li>
33071+
<li><p><strong>Tag Key Rules per Telemetry Type</strong> :</p>
33072+
<ul>
33073+
<li><p>Only one tag key or attribute may be used to define access within a single telemetry type.</p></li>
33074+
<li><p>The same or different tag key may be used across different telemetry types.</p></li>
33075+
</ul>
33076+
</li>
33077+
<li><p><strong>Tag Value Uniqueness</strong> :</p>
33078+
<ul>
33079+
<li><p>Tag values must be unique within a single dataset.</p></li>
33080+
<li><p>A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.</p></li>
33081+
</ul>
33082+
</li>
33083+
</ul>
3305833084
<dl class="field-list simple">
3305933085
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
3306033086
<dd class="field-odd"><ul class="simple">
@@ -33103,7 +33129,28 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
3310333129
<p>Create request for a dataset.</p>
3310433130
<dl class="field-list simple">
3310533131
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
33106-
<dd class="field-odd"><p><strong>data</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.dataset.Dataset" title="datadog_api_client.v2.model.dataset.Dataset"><em>Dataset</em></a>) – Dataset object.</p>
33132+
<dd class="field-odd"><p><strong>data</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.dataset.Dataset" title="datadog_api_client.v2.model.dataset.Dataset"><em>Dataset</em></a>) – <p>Dataset object.</p>
33133+
<p><strong>Datasets Constraints</strong></p>
33134+
<ul class="simple">
33135+
<li><p><strong>Tag Limit per Dataset</strong> :</p>
33136+
<ul>
33137+
<li><p>Each restricted dataset supports a maximum of 10 key:value pairs per product.</p></li>
33138+
</ul>
33139+
</li>
33140+
<li><p><strong>Tag Key Rules per Telemetry Type</strong> :</p>
33141+
<ul>
33142+
<li><p>Only one tag key or attribute may be used to define access within a single telemetry type.</p></li>
33143+
<li><p>The same or different tag key may be used across different telemetry types.</p></li>
33144+
</ul>
33145+
</li>
33146+
<li><p><strong>Tag Value Uniqueness</strong> :</p>
33147+
<ul>
33148+
<li><p>Tag values must be unique within a single dataset.</p></li>
33149+
<li><p>A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.</p></li>
33150+
</ul>
33151+
</li>
33152+
</ul>
33153+
</p>
3310733154
</dd>
3310833155
</dl>
3310933156
</dd></dl>
@@ -33139,7 +33186,67 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
3313933186
<p>Response containing a single dataset object.</p>
3314033187
<dl class="field-list simple">
3314133188
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
33142-
<dd class="field-odd"><p><strong>data</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.dataset.Dataset" title="datadog_api_client.v2.model.dataset.Dataset"><em>Dataset</em></a>) – Dataset object.</p>
33189+
<dd class="field-odd"><p><strong>data</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.dataset.Dataset" title="datadog_api_client.v2.model.dataset.Dataset"><em>Dataset</em></a>) – <p>Dataset object.</p>
33190+
<p><strong>Datasets Constraints</strong></p>
33191+
<ul class="simple">
33192+
<li><p><strong>Tag Limit per Dataset</strong> :</p>
33193+
<ul>
33194+
<li><p>Each restricted dataset supports a maximum of 10 key:value pairs per product.</p></li>
33195+
</ul>
33196+
</li>
33197+
<li><p><strong>Tag Key Rules per Telemetry Type</strong> :</p>
33198+
<ul>
33199+
<li><p>Only one tag key or attribute may be used to define access within a single telemetry type.</p></li>
33200+
<li><p>The same or different tag key may be used across different telemetry types.</p></li>
33201+
</ul>
33202+
</li>
33203+
<li><p><strong>Tag Value Uniqueness</strong> :</p>
33204+
<ul>
33205+
<li><p>Tag values must be unique within a single dataset.</p></li>
33206+
<li><p>A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.</p></li>
33207+
</ul>
33208+
</li>
33209+
</ul>
33210+
</p>
33211+
</dd>
33212+
</dl>
33213+
</dd></dl>
33214+
</section>
33215+
<section id="module-datadog_api_client.v2.model.dataset_update_request">
33216+
<span id="datadog-api-client-v2-model-dataset-update-request-module"></span><h2 id="module-datadog_api_client.v2.model.dataset_update_request">datadog_api_client.v2.model.dataset_update_request module<a class="headerlink" href="#module-datadog_api_client.v2.model.dataset_update_request" title="Link to this heading">¶</a></h2>
33217+
<dl class="py class">
33218+
<dt class="sig sig-object py" id="datadog_api_client.v2.model.dataset_update_request.DatasetUpdateRequest">
33219+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DatasetUpdateRequest</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.dataset_update_request.DatasetUpdateRequest" title="Link to this definition">¶</a></dt>
33220+
<dt class="sig sig-object py">
33221+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DatasetUpdateRequest</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>
33222+
<dt class="sig sig-object py">
33223+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DatasetUpdateRequest</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>
33224+
<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>
33225+
<p>Edit request for a dataset.</p>
33226+
<dl class="field-list simple">
33227+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
33228+
<dd class="field-odd"><p><strong>data</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.dataset.Dataset" title="datadog_api_client.v2.model.dataset.Dataset"><em>Dataset</em></a>) – <p>Dataset object.</p>
33229+
<p><strong>Datasets Constraints</strong></p>
33230+
<ul class="simple">
33231+
<li><p><strong>Tag Limit per Dataset</strong> :</p>
33232+
<ul>
33233+
<li><p>Each restricted dataset supports a maximum of 10 key:value pairs per product.</p></li>
33234+
</ul>
33235+
</li>
33236+
<li><p><strong>Tag Key Rules per Telemetry Type</strong> :</p>
33237+
<ul>
33238+
<li><p>Only one tag key or attribute may be used to define access within a single telemetry type.</p></li>
33239+
<li><p>The same or different tag key may be used across different telemetry types.</p></li>
33240+
</ul>
33241+
</li>
33242+
<li><p><strong>Tag Value Uniqueness</strong> :</p>
33243+
<ul>
33244+
<li><p>Tag values must be unique within a single dataset.</p></li>
33245+
<li><p>A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.</p></li>
33246+
</ul>
33247+
</li>
33248+
</ul>
33249+
</p>
3314333250
</dd>
3314433251
</dl>
3314533252
</dd></dl>
@@ -39216,8 +39323,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
3921639323
These filters act as access control rules. Each filter must follow the tag query syntax used by
3921739324
Datadog (such as <code class="docutils literal notranslate"><span class="pre">@tag.key:value</span></code> ), and only one tag or attribute may be used to define the access strategy
3921839325
per telemetry type.</p></li>
39219-
<li><p><strong>product</strong> (<em>str</em>) – Name of the product the dataset is for. Possible values are ‘apm’, ‘rum’, ‘synthetics’,
39220-
‘metrics’, ‘logs’, ‘sd_repoinfo’, ‘error_tracking’, ‘cloud_cost’, and ‘ml_obs’.</p></li>
39326+
<li><p><strong>product</strong> (<em>str</em>) – Name of the product the dataset is for. Possible values are ‘apm’, ‘rum’,
39327+
‘metrics’, ‘logs’, ‘error_tracking’, and ‘cloud_cost’.</p></li>
3922139328
</ul>
3922239329
</dd>
3922339330
</dl>

0 commit comments

Comments
 (0)