|
| 1 | +<!DOCTYPE html> |
| 2 | +<html> |
| 3 | + <head> |
| 4 | + <meta charset="utf-8"> |
| 5 | +<meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 6 | +<title> |
| 7 | + Module: DatadogAPIClient |
| 8 | + |
| 9 | + — datadog-api-client 2.52.0 documentation |
| 10 | + |
| 11 | +</title> |
| 12 | + |
| 13 | + <link rel="stylesheet" href="css/style.css" type="text/css"> |
| 14 | + |
| 15 | + <link rel="stylesheet" href="css/common.css" type="text/css"> |
| 16 | + |
| 17 | +<script type="text/javascript"> |
| 18 | + pathId = "DatadogAPIClient"; |
| 19 | + relpath = ''; |
| 20 | +</script> |
| 21 | + |
| 22 | + |
| 23 | + <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script> |
| 24 | + |
| 25 | + <script type="text/javascript" charset="utf-8" src="js/app.js"></script> |
| 26 | + |
| 27 | + |
| 28 | + </head> |
| 29 | + <body> |
| 30 | + <div id="main_progress" aria-hidden="true"></div> |
| 31 | + |
| 32 | + <div class="nav_wrap"> |
| 33 | + <iframe id="nav" src="class_list.html?1"></iframe> |
| 34 | + <div id="resizer"></div> |
| 35 | + </div> |
| 36 | + |
| 37 | + <div id="main" tabindex="-1"> |
| 38 | + <div id="header"> |
| 39 | + <div id="menu"> |
| 40 | + |
| 41 | + <a href="_index.html">Index (D)</a> » |
| 42 | + |
| 43 | + |
| 44 | + <span class="title">DatadogAPIClient</span> |
| 45 | + |
| 46 | +</div> |
| 47 | + |
| 48 | + <div id="search"> |
| 49 | + |
| 50 | + <a class="full_list_link" id="class_list_link" |
| 51 | + href="class_list.html"> |
| 52 | + |
| 53 | + <svg width="24" height="24"> |
| 54 | + <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> |
| 55 | + <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> |
| 56 | + <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> |
| 57 | + </svg> |
| 58 | + </a> |
| 59 | + |
| 60 | +</div> |
| 61 | + <div class="clear"></div> |
| 62 | + </div> |
| 63 | + |
| 64 | + <div id="content"><h1>Module: DatadogAPIClient |
| 65 | + |
| 66 | + |
| 67 | + |
| 68 | +</h1> |
| 69 | +<div class="box_info"> |
| 70 | + |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | + |
| 75 | + |
| 76 | + |
| 77 | + |
| 78 | + |
| 79 | + |
| 80 | + |
| 81 | + <dl> |
| 82 | + <dt>Defined in:</dt> |
| 83 | + <dd>lib/datadog_api_client/version.rb<span class="defines">,<br> |
| 84 | + lib/datadog_api_client/models.rb,<br> lib/datadog_api_client/inflector.rb,<br> lib/datadog_api_client/api_client.rb,<br> lib/datadog_api_client/user_agent.rb,<br> lib/datadog_api_client/configuration.rb</span> |
| 85 | + |
| 86 | +</dd> |
| 87 | + </dl> |
| 88 | + |
| 89 | +</div> |
| 90 | + |
| 91 | +<h2>Overview</h2><div class="docstring"> |
| 92 | + <div class="discussion"> |
| 93 | + <h1 id="datadog-api-v2-collection">Datadog API V2 Collection</h1> |
| 94 | + |
| 95 | +<h1 id="collection-of-all-datadog-public-endpoints">Collection of all Datadog Public endpoints.</h1> |
| 96 | + |
| 97 | +<p>The version of the OpenAPI document: 1.0 |
| 98 | +Contact: <a href="mailto:support@datadoghq.com">support@datadoghq.com</a> |
| 99 | +Generated by: <a href="https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator">https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator</a></p> |
| 100 | + |
| 101 | +<p>Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. |
| 102 | + This product includes software developed at Datadog (<a href="https://www.datadoghq.com/">https://www.datadoghq.com/</a>). |
| 103 | + Copyright 2020-Present Datadog, Inc.</p> |
| 104 | + |
| 105 | + |
| 106 | + </div> |
| 107 | +</div> |
| 108 | +<div class="tags"> |
| 109 | + |
| 110 | + |
| 111 | +</div><h2>Defined Under Namespace</h2> |
| 112 | +<p class="children"> |
| 113 | + |
| 114 | + |
| 115 | + <strong class="modules">Modules:</strong> <span class='object_link'><a href="DatadogAPIClient/V1.html" title="DatadogAPIClient::V1 (module)">V1</a></span>, <span class='object_link'><a href="DatadogAPIClient/V2.html" title="DatadogAPIClient::V2 (module)">V2</a></span> |
| 116 | + |
| 117 | + |
| 118 | + |
| 119 | + <strong class="classes">Classes:</strong> <span class='object_link'><a href="DatadogAPIClient/APIClient.html" title="DatadogAPIClient::APIClient (class)">APIClient</a></span>, <span class='object_link'><a href="DatadogAPIClient/APIError.html" title="DatadogAPIClient::APIError (class)">APIError</a></span>, <span class='object_link'><a href="DatadogAPIClient/Configuration.html" title="DatadogAPIClient::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="DatadogAPIClient/DatadogAPIClientInflector.html" title="DatadogAPIClient::DatadogAPIClientInflector (class)">DatadogAPIClientInflector</a></span>, <span class='object_link'><a href="DatadogAPIClient/EnumAttributeValidator.html" title="DatadogAPIClient::EnumAttributeValidator (class)">EnumAttributeValidator</a></span>, <span class='object_link'><a href="DatadogAPIClient/UnparsedObject.html" title="DatadogAPIClient::UnparsedObject (class)">UnparsedObject</a></span> |
| 120 | + |
| 121 | + |
| 122 | +</p> |
| 123 | + |
| 124 | + |
| 125 | + <h2> |
| 126 | + Constant Summary |
| 127 | + <small><a href="#" class="constants_summary_toggle">collapse</a></small> |
| 128 | + </h2> |
| 129 | + |
| 130 | + <dl class="constants"> |
| 131 | + |
| 132 | + <dt id="VERSION-constant" class="">VERSION = |
| 133 | + |
| 134 | + </dt> |
| 135 | + <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>2.52.0</span><span class='tstring_end'>'</span></span></pre></dd> |
| 136 | + |
| 137 | + <dt id="USER_AGENT-constant" class="">USER_AGENT = |
| 138 | + |
| 139 | + </dt> |
| 140 | + <dd><pre class="code"><span class='id identifier rubyid_format'>format</span><span class='lparen'>(</span> |
| 141 | + <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>datadog-api-client-ruby/%<version>s (ruby %<ruver>s; os %<os>s; arch %<arch>s; httparty-version %<httparty_version>s)</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> |
| 142 | + <span class='label'>version:</span> <span class='const'><span class='object_link'><a href="#VERSION-constant" title="DatadogAPIClient::VERSION (constant)">VERSION</a></span></span><span class='comma'>,</span> |
| 143 | + <span class='label'>ruver:</span> <span class='const'>RUBY_VERSION</span><span class='comma'>,</span> |
| 144 | + <span class='label'>os:</span> <span class='const'>RbConfig</span><span class='op'>::</span><span class='const'>CONFIG</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>host_os</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span><span class='comma'>,</span> |
| 145 | + <span class='label'>arch:</span> <span class='const'>RbConfig</span><span class='op'>::</span><span class='const'>CONFIG</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>host_cpu</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> |
| 146 | + <span class='label'>httparty_version:</span> <span class='const'>HTTParty</span><span class='op'>::</span><span class='const'>VERSION</span> |
| 147 | +<span class='rparen'>)</span></pre></dd> |
| 148 | + |
| 149 | + </dl> |
| 150 | + |
| 151 | + |
| 152 | + |
| 153 | + |
| 154 | + |
| 155 | + |
| 156 | + |
| 157 | + |
| 158 | + |
| 159 | + <h2> |
| 160 | + Class Method Summary |
| 161 | + <small><a href="#" class="summary_toggle">collapse</a></small> |
| 162 | + </h2> |
| 163 | + |
| 164 | + <ul class="summary"> |
| 165 | + |
| 166 | + <li class="public "> |
| 167 | + <span class="summary_signature"> |
| 168 | + |
| 169 | + <a href="#configure-class_method" title="configure (class method)">.<strong>configure</strong> ⇒ Object </a> |
| 170 | + |
| 171 | + |
| 172 | + |
| 173 | + </span> |
| 174 | + |
| 175 | + |
| 176 | + |
| 177 | + |
| 178 | + |
| 179 | + |
| 180 | + |
| 181 | + |
| 182 | + |
| 183 | + <span class="summary_desc"><div class='inline'><p>Customize default settings for the SDK using block.</p> |
| 184 | +</div></span> |
| 185 | + |
| 186 | +</li> |
| 187 | + |
| 188 | + |
| 189 | + </ul> |
| 190 | + |
| 191 | + |
| 192 | + |
| 193 | + |
| 194 | + |
| 195 | + <div id="class_method_details" class="method_details_list"> |
| 196 | + <h2>Class Method Details</h2> |
| 197 | + |
| 198 | + |
| 199 | + <div class="method_details first"> |
| 200 | + <h3 class="signature first" id="configure-class_method"> |
| 201 | + |
| 202 | + .<strong>configure</strong> ⇒ <tt>Object</tt> |
| 203 | + |
| 204 | + |
| 205 | + |
| 206 | + |
| 207 | + |
| 208 | +</h3><div class="docstring"> |
| 209 | + <div class="discussion"> |
| 210 | + <p>Customize default settings for the SDK using block. |
| 211 | + DatadogAPIClient::V2.configure do |config| |
| 212 | + config.username = "xxx" |
| 213 | + config.password = "xxx" |
| 214 | + end |
| 215 | +If no block given, return the default Configuration object.</p> |
| 216 | + |
| 217 | + |
| 218 | + </div> |
| 219 | +</div> |
| 220 | +<div class="tags"> |
| 221 | + |
| 222 | + |
| 223 | +</div><table class="source_code"> |
| 224 | + <tr> |
| 225 | + <td> |
| 226 | + <pre class="lines"> |
| 227 | + |
| 228 | + |
| 229 | +35 |
| 230 | +36 |
| 231 | +37 |
| 232 | +38 |
| 233 | +39 |
| 234 | +40 |
| 235 | +41</pre> |
| 236 | + </td> |
| 237 | + <td> |
| 238 | + <pre class="code"><span class="info file"># File 'lib/datadog_api_client/models.rb', line 35</span> |
| 239 | + |
| 240 | +<span class='kw'>def</span> <span class='id identifier rubyid_configure'>configure</span> |
| 241 | + <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span> |
| 242 | + <span class='kw'>yield</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="DatadogAPIClient/Configuration.html" title="DatadogAPIClient::Configuration (class)">Configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_default'><span class='object_link'><a href="DatadogAPIClient/Configuration.html#default-class_method" title="DatadogAPIClient::Configuration.default (method)">default</a></span></span><span class='rparen'>)</span> |
| 243 | + <span class='kw'>else</span> |
| 244 | + <span class='const'><span class='object_link'><a href="DatadogAPIClient/Configuration.html" title="DatadogAPIClient::Configuration (class)">Configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_default'><span class='object_link'><a href="DatadogAPIClient/Configuration.html#default-class_method" title="DatadogAPIClient::Configuration.default (method)">default</a></span></span> |
| 245 | + <span class='kw'>end</span> |
| 246 | +<span class='kw'>end</span></pre> |
| 247 | + </td> |
| 248 | + </tr> |
| 249 | +</table> |
| 250 | +</div> |
| 251 | + |
| 252 | + </div> |
| 253 | + |
| 254 | +</div> |
| 255 | + |
| 256 | + <div id="footer"> |
| 257 | + Generated on Fri Apr 17 13:09:49 2026 by |
| 258 | + <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> |
| 259 | + 0.9.42 (ruby-2.7.8). |
| 260 | +</div> |
| 261 | + |
| 262 | + </div> |
| 263 | + </body> |
| 264 | +</html> |
0 commit comments