Skip to content

Commit 9585e9c

Browse files
[Cloud Network Monitoring API] Update text for response (#2487)
Co-authored-by: ci.datadog-api-spec <[email protected]> 30bb59d
1 parent b47c658 commit 9585e9c

File tree

3 files changed

+14
-18
lines changed

3 files changed

+14
-18
lines changed

Diff for: datadog_api_client.v2.api.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -3767,13 +3767,13 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
37673767
<dl class="py method">
37683768
<dt class="sig sig-object py" id="datadog_api_client.v2.api.cloud_network_monitoring_api.CloudNetworkMonitoringApi.get_aggregated_connections">
37693769
<span class="sig-name descname"><span class="pre">get_aggregated_connections</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">_from</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">to</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">group_by</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">tags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">limit</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.single_aggregated_connection_response_array.SingleAggregatedConnectionResponseArray" title="datadog_api_client.v2.model.single_aggregated_connection_response_array.SingleAggregatedConnectionResponseArray"><span class="pre">SingleAggregatedConnectionResponseArray</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.cloud_network_monitoring_api.CloudNetworkMonitoringApi.get_aggregated_connections" title="Link to this definition">¶</a></dt>
3770-
<dd><p>Get aggregated connections.</p>
3771-
<p>Get aggregated connections</p>
3770+
<dd><p>Get all aggregated connections.</p>
3771+
<p>Get all aggregated connections.</p>
37723772
<dl class="field-list simple">
37733773
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
37743774
<dd class="field-odd"><ul class="simple">
3775-
<li><p><strong>_from</strong> (<em>int</em><em>, </em><em>optional</em>) – Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the “to” timestamp. If neither from nor “to” are provided, the query window is [now - 15m, now].</p></li>
3776-
<li><p><strong>to</strong> (<em>int</em><em>, </em><em>optional</em>) – Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither from nor “to” are provided, the query window is [now - 15m, now].</p></li>
3775+
<li><p><strong>_from</strong> (<em>int</em><em>, </em><em>optional</em>) – Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the <code class="docutils literal notranslate"><span class="pre">to</span></code> timestamp. If neither <code class="docutils literal notranslate"><span class="pre">from</span></code> nor <code class="docutils literal notranslate"><span class="pre">to</span></code> are provided, the query window is <code class="docutils literal notranslate"><span class="pre">[now</span> <span class="pre">-</span> <span class="pre">15m,</span> <span class="pre">now]</span></code>.</p></li>
3776+
<li><p><strong>to</strong> (<em>int</em><em>, </em><em>optional</em>) – Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither <code class="docutils literal notranslate"><span class="pre">from</span></code> nor <code class="docutils literal notranslate"><span class="pre">to</span></code> are provided, the query window is <code class="docutils literal notranslate"><span class="pre">[now</span> <span class="pre">-</span> <span class="pre">15m,</span> <span class="pre">now]</span></code>.</p></li>
37773777
<li><p><strong>group_by</strong> (<em>str</em><em>, </em><em>optional</em>) – Comma-separated list of fields to group connections by.</p></li>
37783778
<li><p><strong>tags</strong> (<em>str</em><em>, </em><em>optional</em>) – Comma-separated list of tags to filter connections by.</p></li>
37793779
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>optional</em>) – The number of connections to be returned. The maximum value is 5000.</p></li>

Diff for: datadog_api_client.v2.model.html

+9-13
Original file line numberDiff line numberDiff line change
@@ -57845,10 +57845,10 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
5784557845
<dt class="sig sig-object py">
5784657846
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SingleAggregatedConnectionResponseArray</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>
5784757847
<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>
57848-
<p>The definition of <code class="docutils literal notranslate"><span class="pre">SingleAggregatedConnectionResponseArray</span></code> object.</p>
57848+
<p>List of aggregated connections.</p>
5784957849
<dl class="field-list simple">
5785057850
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
57851-
<dd class="field-odd"><p><strong>data</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v2.model.single_aggregated_connection_response_data.SingleAggregatedConnectionResponseData" title="datadog_api_client.v2.model.single_aggregated_connection_response_data.SingleAggregatedConnectionResponseData"><em>SingleAggregatedConnectionResponseData</em></a><em>]</em><em>, </em><em>optional</em>) – The <code class="docutils literal notranslate"><span class="pre">SingleAggregatedConnectionResponseArray</span></code> <code class="docutils literal notranslate"><span class="pre">data</span></code>.</p>
57851+
<dd class="field-odd"><p><strong>data</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v2.model.single_aggregated_connection_response_data.SingleAggregatedConnectionResponseData" title="datadog_api_client.v2.model.single_aggregated_connection_response_data.SingleAggregatedConnectionResponseData"><em>SingleAggregatedConnectionResponseData</em></a><em>]</em><em>, </em><em>optional</em>) – Array of aggregated connection objects.</p>
5785257852
</dd>
5785357853
</dl>
5785457854
</dd></dl>
@@ -57863,14 +57863,13 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
5786357863
<dt class="sig sig-object py">
5786457864
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SingleAggregatedConnectionResponseData</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>
5786557865
<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>
57866-
<p>The definition of <code class="docutils literal notranslate"><span class="pre">SingleAggregatedConnectionResponseData</span></code> object.</p>
57866+
<p>Object describing an aggregated connection.</p>
5786757867
<dl class="field-list simple">
5786857868
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
5786957869
<dd class="field-odd"><ul class="simple">
57870-
<li><p><strong>attributes</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.single_aggregated_connection_response_data_attributes.SingleAggregatedConnectionResponseDataAttributes" title="datadog_api_client.v2.model.single_aggregated_connection_response_data_attributes.SingleAggregatedConnectionResponseDataAttributes"><em>SingleAggregatedConnectionResponseDataAttributes</em></a><em>, </em><em>optional</em>) – The definition of <code class="docutils literal notranslate"><span class="pre">SingleAggregatedConnectionResponseDataAttributes</span></code> object.</p></li>
57871-
<li><p><strong>id</strong> (<em>str</em><em>, </em><em>optional</em>) – The <code class="docutils literal notranslate"><span class="pre">SingleAggregatedConnectionResponseData</span></code> <code class="docutils literal notranslate"><span class="pre">id</span></code>.</p></li>
57872-
<li><p><strong>type</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.single_aggregated_connection_response_data_type.SingleAggregatedConnectionResponseDataType" title="datadog_api_client.v2.model.single_aggregated_connection_response_data_type.SingleAggregatedConnectionResponseDataType"><em>SingleAggregatedConnectionResponseDataType</em></a><em>, </em><em>optional</em>) – Aggregated connection resource type. Allowed enum values: <code class="docutils literal notranslate"><span class="pre">aggregated_connection</span></code>.
57873-
default: <code class="docutils literal notranslate"><span class="pre">aggregated_connection</span></code></p></li>
57870+
<li><p><strong>attributes</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.single_aggregated_connection_response_data_attributes.SingleAggregatedConnectionResponseDataAttributes" title="datadog_api_client.v2.model.single_aggregated_connection_response_data_attributes.SingleAggregatedConnectionResponseDataAttributes"><em>SingleAggregatedConnectionResponseDataAttributes</em></a><em>, </em><em>optional</em>) – Attributes for an aggregated connection.</p></li>
57871+
<li><p><strong>id</strong> (<em>str</em><em>, </em><em>optional</em>) – A unique identifier for the aggregated connection based on the group by values.</p></li>
57872+
<li><p><strong>type</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.single_aggregated_connection_response_data_type.SingleAggregatedConnectionResponseDataType" title="datadog_api_client.v2.model.single_aggregated_connection_response_data_type.SingleAggregatedConnectionResponseDataType"><em>SingleAggregatedConnectionResponseDataType</em></a><em>, </em><em>optional</em>) – Aggregated connection resource type.</p></li>
5787457873
</ul>
5787557874
</dd>
5787657875
</dl>
@@ -57886,13 +57885,13 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
5788657885
<dt class="sig sig-object py">
5788757886
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SingleAggregatedConnectionResponseDataAttributes</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>
5788857887
<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>
57889-
<p>The definition of <code class="docutils literal notranslate"><span class="pre">SingleAggregatedConnectionResponseDataAttributes</span></code> object.</p>
57888+
<p>Attributes for an aggregated connection.</p>
5789057889
<dl class="field-list simple">
5789157890
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
5789257891
<dd class="field-odd"><ul class="simple">
5789357892
<li><p><strong>bytes_sent_by_client</strong> (<em>int</em><em>, </em><em>optional</em>) – The total number of bytes sent by the client over the given period.</p></li>
5789457893
<li><p><strong>bytes_sent_by_server</strong> (<em>int</em><em>, </em><em>optional</em>) – The total number of bytes sent by the server over the given period.</p></li>
57895-
<li><p><strong>group_bys</strong> (<em>{str:</em><em> (</em><em>[</em><em>str</em><em>]</em><em>,</em><em>)</em><em>}</em><em>, </em><em>optional</em>) – The <code class="docutils literal notranslate"><span class="pre">attributes</span></code> <code class="docutils literal notranslate"><span class="pre">group_bys</span></code>.</p></li>
57894+
<li><p><strong>group_bys</strong> (<em>{str:</em><em> (</em><em>[</em><em>str</em><em>]</em><em>,</em><em>)</em><em>}</em><em>, </em><em>optional</em>) – The key, value pairs for each group by.</p></li>
5789657895
<li><p><strong>packets_sent_by_client</strong> (<em>int</em><em>, </em><em>optional</em>) – The total number of packets sent by the client over the given period.</p></li>
5789757896
<li><p><strong>packets_sent_by_server</strong> (<em>int</em><em>, </em><em>optional</em>) – The total number of packets sent by the server over the given period.</p></li>
5789857897
<li><p><strong>rtt_micro_seconds</strong> (<em>int</em><em>, </em><em>optional</em>) – Measured as TCP smoothed round trip time in microseconds (the time between a TCP frame being sent and acknowledged).</p></li>
@@ -57917,10 +57916,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
5791757916
<dt class="sig sig-object py">
5791857917
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SingleAggregatedConnectionResponseDataType</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>
5791957918
<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>
57920-
<dl class="simple">
57921-
<dt>Aggregated connection resource type. Allowed enum values: <cite>aggregated_connection</cite>.</dt><dd><p>default: <cite>aggregated_connection</cite></p>
57922-
</dd>
57923-
</dl>
57919+
<p>Aggregated connection resource type.</p>
5792457920
<dl class="field-list simple">
5792557921
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
5792657922
<dd class="field-odd"><ul class="simple">

Diff for: searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)