class DatadogAPIClient::V2::DashboardListsAPI
Attributes
Public Class Methods
# File lib/datadog_api_client/v2/api/dashboard_lists_api.rb, line 22 def initialize(api_client = APIClient.default) @api_client = api_client end
Public Instance Methods
Add Items to a Dashboard List Add dashboards to an existing dashboard list. @param dashboard_list_id [Integer] ID of the dashboard list to add items to. @param body [DashboardListAddItemsRequest] Dashboards to add to the dashboard list. @param [Hash] opts the optional parameters @return [DashboardListAddItemsResponse]
# File lib/datadog_api_client/v2/api/dashboard_lists_api.rb, line 31 def create_dashboard_list_items(dashboard_list_id, body, opts = {}) data, _status_code, _headers = create_dashboard_list_items_with_http_info(dashboard_list_id, body, opts) data end
Add Items to a Dashboard List Add dashboards to an existing dashboard list. @param dashboard_list_id [Integer] ID of the dashboard list to add items to. @param body [DashboardListAddItemsRequest] Dashboards to add to the dashboard list. @param [Hash] opts the optional parameters @return [Array<(DashboardListAddItemsResponse
, Integer, Hash)>] DashboardListAddItemsResponse
data, response status code and response headers
# File lib/datadog_api_client/v2/api/dashboard_lists_api.rb, line 42 def create_dashboard_list_items_with_http_info(dashboard_list_id, body, opts = {}) if @api_client.config.unstable_operations.has_key?(:create_dashboard_list_items) unstable_enabled = @api_client.config.unstable_operations[:create_dashboard_list_items] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "create_dashboard_list_items") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_dashboard_list_items")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DashboardListsAPI.create_dashboard_list_items ...' end # verify the required parameter 'dashboard_list_id' is set if @api_client.config.client_side_validation && dashboard_list_id.nil? fail ArgumentError, "Missing the required parameter 'dashboard_list_id' when calling DashboardListsAPI.create_dashboard_list_items" 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 DashboardListsAPI.create_dashboard_list_items" end # resource path local_var_path = '/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards'.sub('{' + 'dashboard_list_id' + '}', CGI.escape(dashboard_list_id.to_s)) # 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] || 'DashboardListAddItemsResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] new_options = opts.merge( :operation => :create_dashboard_list_items, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: DashboardListsAPI#create_dashboard_list_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete items from a dashboard list Delete dashboards from an existing dashboard list. @param dashboard_list_id [Integer] ID of the dashboard list to delete items from. @param body [DashboardListDeleteItemsRequest] Dashboards to delete from the dashboard list. @param [Hash] opts the optional parameters @return [DashboardListDeleteItemsResponse]
# File lib/datadog_api_client/v2/api/dashboard_lists_api.rb, line 112 def delete_dashboard_list_items(dashboard_list_id, body, opts = {}) data, _status_code, _headers = delete_dashboard_list_items_with_http_info(dashboard_list_id, body, opts) data end
Delete items from a dashboard list Delete dashboards from an existing dashboard list. @param dashboard_list_id [Integer] ID of the dashboard list to delete items from. @param body [DashboardListDeleteItemsRequest] Dashboards to delete from the dashboard list. @param [Hash] opts the optional parameters @return [Array<(DashboardListDeleteItemsResponse
, Integer, Hash)>] DashboardListDeleteItemsResponse
data, response status code and response headers
# File lib/datadog_api_client/v2/api/dashboard_lists_api.rb, line 123 def delete_dashboard_list_items_with_http_info(dashboard_list_id, body, opts = {}) if @api_client.config.unstable_operations.has_key?(:delete_dashboard_list_items) unstable_enabled = @api_client.config.unstable_operations[:delete_dashboard_list_items] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_dashboard_list_items") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_dashboard_list_items")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DashboardListsAPI.delete_dashboard_list_items ...' end # verify the required parameter 'dashboard_list_id' is set if @api_client.config.client_side_validation && dashboard_list_id.nil? fail ArgumentError, "Missing the required parameter 'dashboard_list_id' when calling DashboardListsAPI.delete_dashboard_list_items" 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 DashboardListsAPI.delete_dashboard_list_items" end # resource path local_var_path = '/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards'.sub('{' + 'dashboard_list_id' + '}', CGI.escape(dashboard_list_id.to_s)) # 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] || 'DashboardListDeleteItemsResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] new_options = opts.merge( :operation => :delete_dashboard_list_items, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: DashboardListsAPI#delete_dashboard_list_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get items of a Dashboard List Fetch the dashboard list’s dashboard definitions. @param dashboard_list_id [Integer] ID of the dashboard list to get items from. @param [Hash] opts the optional parameters @return [DashboardListItems]
# File lib/datadog_api_client/v2/api/dashboard_lists_api.rb, line 192 def get_dashboard_list_items(dashboard_list_id, opts = {}) data, _status_code, _headers = get_dashboard_list_items_with_http_info(dashboard_list_id, opts) data end
Get items of a Dashboard List Fetch the dashboard list’s dashboard definitions. @param dashboard_list_id [Integer] ID of the dashboard list to get items from. @param [Hash] opts the optional parameters @return [Array<(DashboardListItems
, Integer, Hash)>] DashboardListItems
data, response status code and response headers
# File lib/datadog_api_client/v2/api/dashboard_lists_api.rb, line 202 def get_dashboard_list_items_with_http_info(dashboard_list_id, opts = {}) if @api_client.config.unstable_operations.has_key?(:get_dashboard_list_items) unstable_enabled = @api_client.config.unstable_operations[:get_dashboard_list_items] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "get_dashboard_list_items") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_dashboard_list_items")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DashboardListsAPI.get_dashboard_list_items ...' end # verify the required parameter 'dashboard_list_id' is set if @api_client.config.client_side_validation && dashboard_list_id.nil? fail ArgumentError, "Missing the required parameter 'dashboard_list_id' when calling DashboardListsAPI.get_dashboard_list_items" end # resource path local_var_path = '/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards'.sub('{' + 'dashboard_list_id' + '}', CGI.escape(dashboard_list_id.to_s)) # 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] || 'DashboardListItems' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] new_options = opts.merge( :operation => :get_dashboard_list_items, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: DashboardListsAPI#get_dashboard_list_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update items of a dashboard list Update dashboards of an existing dashboard list. @param dashboard_list_id [Integer] ID of the dashboard list to update items from. @param body [DashboardListUpdateItemsRequest] New dashboards of the dashboard list. @param [Hash] opts the optional parameters @return [DashboardListUpdateItemsResponse]
# File lib/datadog_api_client/v2/api/dashboard_lists_api.rb, line 266 def update_dashboard_list_items(dashboard_list_id, body, opts = {}) data, _status_code, _headers = update_dashboard_list_items_with_http_info(dashboard_list_id, body, opts) data end
Update items of a dashboard list Update dashboards of an existing dashboard list. @param dashboard_list_id [Integer] ID of the dashboard list to update items from. @param body [DashboardListUpdateItemsRequest] New dashboards of the dashboard list. @param [Hash] opts the optional parameters @return [Array<(DashboardListUpdateItemsResponse
, Integer, Hash)>] DashboardListUpdateItemsResponse
data, response status code and response headers
# File lib/datadog_api_client/v2/api/dashboard_lists_api.rb, line 277 def update_dashboard_list_items_with_http_info(dashboard_list_id, body, opts = {}) if @api_client.config.unstable_operations.has_key?(:update_dashboard_list_items) unstable_enabled = @api_client.config.unstable_operations[:update_dashboard_list_items] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "update_dashboard_list_items") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_dashboard_list_items")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DashboardListsAPI.update_dashboard_list_items ...' end # verify the required parameter 'dashboard_list_id' is set if @api_client.config.client_side_validation && dashboard_list_id.nil? fail ArgumentError, "Missing the required parameter 'dashboard_list_id' when calling DashboardListsAPI.update_dashboard_list_items" 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 DashboardListsAPI.update_dashboard_list_items" end # resource path local_var_path = '/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards'.sub('{' + 'dashboard_list_id' + '}', CGI.escape(dashboard_list_id.to_s)) # 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] || 'DashboardListUpdateItemsResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] new_options = opts.merge( :operation => :update_dashboard_list_items, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: DashboardListsAPI#update_dashboard_list_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end