Class: DatadogAPIClient::V2::AppBuilderAPI
- Inherits:
-
Object
- Object
- DatadogAPIClient::V2::AppBuilderAPI
- Defined in:
- lib/datadog_api_client/v2/api/app_builder_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_app(body, opts = {}) ⇒ Object
Create App.
-
#create_app_with_http_info(body, opts = {}) ⇒ Array<(CreateAppResponse, Integer, Hash)>
Create App.
-
#delete_app(app_id, opts = {}) ⇒ Object
Delete App.
-
#delete_app_with_http_info(app_id, opts = {}) ⇒ Array<(DeleteAppResponse, Integer, Hash)>
Delete App.
-
#delete_apps(body, opts = {}) ⇒ Object
Delete Multiple Apps.
-
#delete_apps_with_http_info(body, opts = {}) ⇒ Array<(DeleteAppsResponse, Integer, Hash)>
Delete Multiple Apps.
-
#get_app(app_id, opts = {}) ⇒ Object
Get App.
-
#get_app_with_http_info(app_id, opts = {}) ⇒ Array<(GetAppResponse, Integer, Hash)>
Get App.
-
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ AppBuilderAPI
constructor
A new instance of AppBuilderAPI.
-
#list_apps(opts = {}) ⇒ Object
List Apps.
-
#list_apps_with_http_info(opts = {}) ⇒ Array<(ListAppsResponse, Integer, Hash)>
List Apps.
-
#publish_app(app_id, opts = {}) ⇒ Object
Publish App.
-
#publish_app_with_http_info(app_id, opts = {}) ⇒ Array<(PublishAppResponse, Integer, Hash)>
Publish App.
-
#unpublish_app(app_id, opts = {}) ⇒ Object
Unpublish App.
-
#unpublish_app_with_http_info(app_id, opts = {}) ⇒ Array<(UnpublishAppResponse, Integer, Hash)>
Unpublish App.
-
#update_app(app_id, body, opts = {}) ⇒ Object
Update App.
-
#update_app_with_http_info(app_id, body, opts = {}) ⇒ Array<(UpdateAppResponse, Integer, Hash)>
Update App.
Constructor Details
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ AppBuilderAPI
Returns a new instance of AppBuilderAPI.
22 23 24 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 22 def initialize(api_client = DatadogAPIClient::APIClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
20 21 22 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#create_app(body, opts = {}) ⇒ Object
Create App.
29 30 31 32 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 29 def create_app(body, opts = {}) data, _status_code, _headers = create_app_with_http_info(body, opts) data end |
#create_app_with_http_info(body, opts = {}) ⇒ Array<(CreateAppResponse, Integer, Hash)>
Create App.
Create a new app, returning the app ID.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 41 def create_app_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AppBuilderAPI.create_app ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling AppBuilderAPI.create_app" end # resource path local_var_path = '/api/v2/app-builder/apps' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'CreateAppResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :create_app, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type, :api_version => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AppBuilderAPI#create_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_app(app_id, opts = {}) ⇒ Object
Delete App.
96 97 98 99 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 96 def delete_app(app_id, opts = {}) data, _status_code, _headers = delete_app_with_http_info(app_id, opts) data end |
#delete_app_with_http_info(app_id, opts = {}) ⇒ Array<(DeleteAppResponse, Integer, Hash)>
Delete App.
Delete a single app.
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 108 def delete_app_with_http_info(app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AppBuilderAPI.delete_app ...' end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.delete_app" end # resource path local_var_path = '/api/v2/app-builder/apps/{app_id}'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'DeleteAppResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :delete_app, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type, :api_version => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AppBuilderAPI#delete_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_apps(body, opts = {}) ⇒ Object
Delete Multiple Apps.
161 162 163 164 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 161 def delete_apps(body, opts = {}) data, _status_code, _headers = delete_apps_with_http_info(body, opts) data end |
#delete_apps_with_http_info(body, opts = {}) ⇒ Array<(DeleteAppsResponse, Integer, Hash)>
Delete Multiple Apps.
Delete multiple apps in a single request from a list of app IDs.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 173 def delete_apps_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AppBuilderAPI.delete_apps ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling AppBuilderAPI.delete_apps" end # resource path local_var_path = '/api/v2/app-builder/apps' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'DeleteAppsResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :delete_apps, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type, :api_version => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AppBuilderAPI#delete_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_app(app_id, opts = {}) ⇒ Object
Get App.
228 229 230 231 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 228 def get_app(app_id, opts = {}) data, _status_code, _headers = get_app_with_http_info(app_id, opts) data end |
#get_app_with_http_info(app_id, opts = {}) ⇒ Array<(GetAppResponse, Integer, Hash)>
Get App.
Get the full definition of an app.
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 241 def get_app_with_http_info(app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AppBuilderAPI.get_app ...' end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.get_app" end # resource path local_var_path = '/api/v2/app-builder/apps/{app_id}'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'GetAppResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :get_app, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type, :api_version => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AppBuilderAPI#get_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_apps(opts = {}) ⇒ Object
List Apps.
295 296 297 298 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 295 def list_apps(opts = {}) data, _status_code, _headers = list_apps_with_http_info(opts) data end |
#list_apps_with_http_info(opts = {}) ⇒ Array<(ListAppsResponse, Integer, Hash)>
List Apps.
List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint.
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 317 def list_apps_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AppBuilderAPI.list_apps ...' end # resource path local_var_path = '/api/v2/app-builder/apps' # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'filter[user_name]'] = opts[:'filter_user_name'] if !opts[:'filter_user_name'].nil? query_params[:'filter[user_uuid]'] = opts[:'filter_user_uuid'] if !opts[:'filter_user_uuid'].nil? query_params[:'filter[name]'] = opts[:'filter_name'] if !opts[:'filter_name'].nil? query_params[:'filter[query]'] = opts[:'filter_query'] if !opts[:'filter_query'].nil? query_params[:'filter[deployed]'] = opts[:'filter_deployed'] if !opts[:'filter_deployed'].nil? query_params[:'filter[tags]'] = opts[:'filter_tags'] if !opts[:'filter_tags'].nil? query_params[:'filter[favorite]'] = opts[:'filter_favorite'] if !opts[:'filter_favorite'].nil? query_params[:'filter[self_service]'] = opts[:'filter_self_service'] if !opts[:'filter_self_service'].nil? query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :csv) if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'ListAppsResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :list_apps, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type, :api_version => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AppBuilderAPI#list_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#publish_app(app_id, opts = {}) ⇒ Object
Publish App.
377 378 379 380 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 377 def publish_app(app_id, opts = {}) data, _status_code, _headers = publish_app_with_http_info(app_id, opts) data end |
#publish_app_with_http_info(app_id, opts = {}) ⇒ Array<(PublishAppResponse, Integer, Hash)>
Publish App.
Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a [Restriction Policy](docs.datadoghq.com/api/latest/restriction-policies/) on the app if a policy does not yet exist.
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 389 def publish_app_with_http_info(app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AppBuilderAPI.publish_app ...' end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.publish_app" end # resource path local_var_path = '/api/v2/app-builder/apps/{app_id}/deployment'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PublishAppResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :publish_app, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type, :api_version => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AppBuilderAPI#publish_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#unpublish_app(app_id, opts = {}) ⇒ Object
Unpublish App.
442 443 444 445 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 442 def unpublish_app(app_id, opts = {}) data, _status_code, _headers = unpublish_app_with_http_info(app_id, opts) data end |
#unpublish_app_with_http_info(app_id, opts = {}) ⇒ Array<(UnpublishAppResponse, Integer, Hash)>
Unpublish App.
Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a ‘deployment` object on the app, with a nil `app_version_id` (`00000000-0000-0000-0000-000000000000`). The app can still be updated and published again in the future.
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 454 def unpublish_app_with_http_info(app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AppBuilderAPI.unpublish_app ...' end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.unpublish_app" end # resource path local_var_path = '/api/v2/app-builder/apps/{app_id}/deployment'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'UnpublishAppResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :unpublish_app, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type, :api_version => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AppBuilderAPI#unpublish_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_app(app_id, body, opts = {}) ⇒ Object
Update App.
507 508 509 510 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 507 def update_app(app_id, body, opts = {}) data, _status_code, _headers = update_app_with_http_info(app_id, body, opts) data end |
#update_app_with_http_info(app_id, body, opts = {}) ⇒ Array<(UpdateAppResponse, Integer, Hash)>
Update App.
Update an existing app. This creates a new version of the app.
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 |
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 520 def update_app_with_http_info(app_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AppBuilderAPI.update_app ...' end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.update_app" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling AppBuilderAPI.update_app" end # resource path local_var_path = '/api/v2/app-builder/apps/{app_id}'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'UpdateAppResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :update_app, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type, :api_version => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AppBuilderAPI#update_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |