Update UA API docs to reflect deprecated values for estimated usage types (#2666)

Co-authored-by: ci.datadog-api-spec <[email protected]> 3e70e89

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

datadog_api_client.v1.api.html

@@ -5154,7 +5154,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>start_hr</strong> (<em>datetime</em>) – Datetime in ISO-8601 format, UTC, precise to hour: <code class="docutils literal notranslate"><span class="pre">[YYYY-MM-DDThh]</span></code> for usage beginning at this hour.</p></li>
-<li><p><strong>usage_type</strong> (<a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.hourly_usage_attribution_usage_type.HourlyUsageAttributionUsageType" title="datadog_api_client.v1.model.hourly_usage_attribution_usage_type.HourlyUsageAttributionUsageType"><em>HourlyUsageAttributionUsageType</em></a>) – Usage type to retrieve.</p></li>
+<li><p><strong>usage_type</strong> (<a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.hourly_usage_attribution_usage_type.HourlyUsageAttributionUsageType" title="datadog_api_client.v1.model.hourly_usage_attribution_usage_type.HourlyUsageAttributionUsageType"><em>HourlyUsageAttributionUsageType</em></a>) – Usage type to retrieve. The following values have been <strong>deprecated</strong> :
+<code class="docutils literal notranslate"><span class="pre">estimated_indexed_spans_usage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_ingested_spans_usage</span></code>.</p></li>
 <li><p><strong>end_hr</strong> (<em>datetime</em><em>, </em><em>optional</em>) – Datetime in ISO-8601 format, UTC, precise to hour: <code class="docutils literal notranslate"><span class="pre">[YYYY-MM-DDThh]</span></code> for usage ending
 <strong>before</strong> this hour.</p></li>
 <li><p><strong>next_record_id</strong> (<em>str</em><em>, </em><em>optional</em>) – List following results with a next_record_id provided in the previous query.</p></li>
@@ -5250,10 +5251,14 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>start_month</strong> (<em>datetime</em>) – Datetime in ISO-8601 format, UTC, precise to month: <code class="docutils literal notranslate"><span class="pre">[YYYY-MM]</span></code> for usage beginning in this month.
 Maximum of 15 months ago.</p></li>
-<li><p><strong>fields</strong> (<a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.monthly_usage_attribution_supported_metrics.MonthlyUsageAttributionSupportedMetrics" title="datadog_api_client.v1.model.monthly_usage_attribution_supported_metrics.MonthlyUsageAttributionSupportedMetrics"><em>MonthlyUsageAttributionSupportedMetrics</em></a>) – Comma-separated list of usage types to return, or <code class="docutils literal notranslate"><span class="pre">*</span></code> for all usage types.</p></li>
+<li><p><strong>fields</strong> (<a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.monthly_usage_attribution_supported_metrics.MonthlyUsageAttributionSupportedMetrics" title="datadog_api_client.v1.model.monthly_usage_attribution_supported_metrics.MonthlyUsageAttributionSupportedMetrics"><em>MonthlyUsageAttributionSupportedMetrics</em></a>) – Comma-separated list of usage types to return, or <code class="docutils literal notranslate"><span class="pre">*</span></code> for all usage types.
+The following values have been <strong>deprecated</strong> :
+<code class="docutils literal notranslate"><span class="pre">estimated_indexed_spans_usage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_indexed_spans_percentage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_ingested_spans_usage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_ingested_spans_percentage</span></code>.</p></li>
 <li><p><strong>end_month</strong> (<em>datetime</em><em>, </em><em>optional</em>) – Datetime in ISO-8601 format, UTC, precise to month: <code class="docutils literal notranslate"><span class="pre">[YYYY-MM]</span></code> for usage ending this month.</p></li>
 <li><p><strong>sort_direction</strong> (<a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.usage_sort_direction.UsageSortDirection" title="datadog_api_client.v1.model.usage_sort_direction.UsageSortDirection"><em>UsageSortDirection</em></a><em>, </em><em>optional</em>) – The direction to sort by: <code class="docutils literal notranslate"><span class="pre">[desc,</span> <span class="pre">asc]</span></code>.</p></li>
-<li><p><strong>sort_name</strong> (<a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.monthly_usage_attribution_supported_metrics.MonthlyUsageAttributionSupportedMetrics" title="datadog_api_client.v1.model.monthly_usage_attribution_supported_metrics.MonthlyUsageAttributionSupportedMetrics"><em>MonthlyUsageAttributionSupportedMetrics</em></a><em>, </em><em>optional</em>) – The field to sort by.</p></li>
+<li><p><strong>sort_name</strong> (<a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.monthly_usage_attribution_supported_metrics.MonthlyUsageAttributionSupportedMetrics" title="datadog_api_client.v1.model.monthly_usage_attribution_supported_metrics.MonthlyUsageAttributionSupportedMetrics"><em>MonthlyUsageAttributionSupportedMetrics</em></a><em>, </em><em>optional</em>) – The field to sort by.
+The following values have been <strong>deprecated</strong> :
+<code class="docutils literal notranslate"><span class="pre">estimated_indexed_spans_usage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_indexed_spans_percentage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_ingested_spans_usage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_ingested_spans_percentage</span></code>.</p></li>
 <li><p><strong>tag_breakdown_keys</strong> (<em>str</em><em>, </em><em>optional</em>) – <p>Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags.</p>
 <p>To see which tags are available, look for the value of <code class="docutils literal notranslate"><span class="pre">tag_config_source</span></code> in the API response.</p>
 </p></li>

datadog_api_client.v1.model.html

@@ -11066,7 +11066,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 </p></li>
 <li><p><strong>total_usage_sum</strong> (<em>float</em><em>, </em><em>optional</em>) – Total product usage for the given tags within the hour.</p></li>
 <li><p><strong>updated_at</strong> (<em>str</em><em>, </em><em>optional</em>) – Shows the most recent hour in the current month for all organizations where usages are calculated.</p></li>
-<li><p><strong>usage_type</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.hourly_usage_attribution_usage_type.HourlyUsageAttributionUsageType" title="datadog_api_client.v1.model.hourly_usage_attribution_usage_type.HourlyUsageAttributionUsageType"><em>HourlyUsageAttributionUsageType</em></a><em>, </em><em>optional</em>) – Supported products for hourly usage attribution requests.</p></li>
+<li><p><strong>usage_type</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.hourly_usage_attribution_usage_type.HourlyUsageAttributionUsageType" title="datadog_api_client.v1.model.hourly_usage_attribution_usage_type.HourlyUsageAttributionUsageType"><em>HourlyUsageAttributionUsageType</em></a><em>, </em><em>optional</em>) – Supported products for hourly usage attribution requests.
+The following values have been <strong>deprecated</strong> : <code class="docutils literal notranslate"><span class="pre">estimated_indexed_spans_usage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_ingested_spans_usage</span></code>.</p></li>
 </ul>
 </dd>
 </dl>
@@ -11139,7 +11140,10 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <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">HourlyUsageAttributionUsageType</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.ModelSimple" title="datadog_api_client.model_utils.ModelSimple"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSimple</span></code></a></p>
-<p>Supported products for hourly usage attribution requests.</p>
+<dl class="simple">
+<dt>Supported products for hourly usage attribution requests.</dt><dd><p>The following values have been <strong>deprecated</strong>: <cite>estimated_indexed_spans_usage</cite>, <cite>estimated_ingested_spans_usage</cite>.</p>
+</dd>
+</dl>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
@@ -15495,7 +15499,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 In this scenario the API returns the total usage, not broken down by tags.</p>
 </p></li>
 <li><p><strong>updated_at</strong> (<em>datetime</em><em>, </em><em>optional</em>) – Datetime of the most recent update to the usage values.</p></li>
-<li><p><strong>values</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.monthly_usage_attribution_values.MonthlyUsageAttributionValues" title="datadog_api_client.v1.model.monthly_usage_attribution_values.MonthlyUsageAttributionValues"><em>MonthlyUsageAttributionValues</em></a><em>, </em><em>optional</em>) – Fields in Usage Summary by tag(s).</p></li>
+<li><p><strong>values</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.monthly_usage_attribution_values.MonthlyUsageAttributionValues" title="datadog_api_client.v1.model.monthly_usage_attribution_values.MonthlyUsageAttributionValues"><em>MonthlyUsageAttributionValues</em></a><em>, </em><em>optional</em>) – Fields in Usage Summary by tag(s).
+The following values have been <strong>deprecated</strong> : <code class="docutils literal notranslate"><span class="pre">estimated_indexed_spans_usage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_indexed_spans_percentage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_ingested_spans_usage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_ingested_spans_percentage</span></code>.</p></li>
 </ul>
 </dd>
 </dl>
@@ -15602,7 +15607,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <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">MonthlyUsageAttributionValues</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>Fields in Usage Summary by tag(s).</p>
+<p>Fields in Usage Summary by tag(s).
+The following values have been <strong>deprecated</strong> : <code class="docutils literal notranslate"><span class="pre">estimated_indexed_spans_usage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_indexed_spans_percentage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_ingested_spans_usage</span></code> , <code class="docutils literal notranslate"><span class="pre">estimated_ingested_spans_percentage</span></code>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">