class DatadogAPIClient::V2::IncidentServicesAPI
Attributes
Public Class Methods
# File lib/datadog_api_client/v2/api/incident_services_api.rb, line 22 def initialize(api_client = APIClient.default) @api_client = api_client end
Public Instance Methods
Create a new incident service Creates a new incident service. @param body [IncidentServiceCreateRequest] Incident Service Payload. @param [Hash] opts the optional parameters @return [IncidentServiceResponse]
# File lib/datadog_api_client/v2/api/incident_services_api.rb, line 30 def create_incident_service(body, opts = {}) data, _status_code, _headers = create_incident_service_with_http_info(body, opts) data end
Create a new incident service Creates a new incident service. @param body [IncidentServiceCreateRequest] Incident Service Payload. @param [Hash] opts the optional parameters @return [Array<(IncidentServiceResponse
, Integer, Hash)>] IncidentServiceResponse
data, response status code and response headers
# File lib/datadog_api_client/v2/api/incident_services_api.rb, line 40 def create_incident_service_with_http_info(body, opts = {}) if @api_client.config.unstable_operations.has_key?(:create_incident_service) unstable_enabled = @api_client.config.unstable_operations[:create_incident_service] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "create_incident_service") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_incident_service")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: IncidentServicesAPI.create_incident_service ...' 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 IncidentServicesAPI.create_incident_service" end # resource path local_var_path = '/api/v2/services' # 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] || 'IncidentServiceResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] new_options = opts.merge( :operation => :create_incident_service, :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: IncidentServicesAPI#create_incident_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete an existing incident service Deletes an existing incident service. @param service_id [String] The ID of the incident service. @param [Hash] opts the optional parameters @return [nil]
# File lib/datadog_api_client/v2/api/incident_services_api.rb, line 105 def delete_incident_service(service_id, opts = {}) delete_incident_service_with_http_info(service_id, opts) nil end
Delete an existing incident service Deletes an existing incident service. @param service_id [String] The ID of the incident service. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
# File lib/datadog_api_client/v2/api/incident_services_api.rb, line 115 def delete_incident_service_with_http_info(service_id, opts = {}) if @api_client.config.unstable_operations.has_key?(:delete_incident_service) unstable_enabled = @api_client.config.unstable_operations[:delete_incident_service] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_incident_service") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_incident_service")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: IncidentServicesAPI.delete_incident_service ...' end # verify the required parameter 'service_id' is set if @api_client.config.client_side_validation && service_id.nil? fail ArgumentError, "Missing the required parameter 'service_id' when calling IncidentServicesAPI.delete_incident_service" end # resource path local_var_path = '/api/v2/services/{service_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_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] # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] new_options = opts.merge( :operation => :delete_incident_service, :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: IncidentServicesAPI#delete_incident_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get details of an incident service Get details of an incident service. If the `include` query parameter is provided, the included attribute will contain the users related to these incident services. @param service_id [String] The ID of the incident service. @param [Hash] opts the optional parameters @option opts [IncidentRelatedObject] :include Specifies which types of related objects should be included in the response. @return [IncidentServiceResponse]
# File lib/datadog_api_client/v2/api/incident_services_api.rb, line 179 def get_incident_service(service_id, opts = {}) data, _status_code, _headers = get_incident_service_with_http_info(service_id, opts) data end
Get details of an incident service Get details of an incident service. If the `include` query parameter is provided, the included attribute will contain the users related to these incident services. @param service_id [String] The ID of the incident service. @param [Hash] opts the optional parameters @option opts [IncidentRelatedObject] :include Specifies which types of related objects should be included in the response. @return [Array<(IncidentServiceResponse
, Integer, Hash)>] IncidentServiceResponse
data, response status code and response headers
# File lib/datadog_api_client/v2/api/incident_services_api.rb, line 190 def get_incident_service_with_http_info(service_id, opts = {}) if @api_client.config.unstable_operations.has_key?(:get_incident_service) unstable_enabled = @api_client.config.unstable_operations[:get_incident_service] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "get_incident_service") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_incident_service")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: IncidentServicesAPI.get_incident_service ...' end # verify the required parameter 'service_id' is set if @api_client.config.client_side_validation && service_id.nil? fail ArgumentError, "Missing the required parameter 'service_id' when calling IncidentServicesAPI.get_incident_service" end # resource path local_var_path = '/api/v2/services/{service_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'include'] = opts[:'include'] if !opts[:'include'].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] || 'IncidentServiceResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] new_options = opts.merge( :operation => :get_incident_service, :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: IncidentServicesAPI#get_incident_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a list of all incident services Get all incident services uploaded for the requesting user's organization. If the `include` query parameter is provided, the included attribute will contain the users related to these incident services. @param [Hash] opts the optional parameters @option opts [IncidentRelatedObject] :include Specifies which types of related objects should be included in the response. @option opts [Integer] :page_size Size for a given page. (default to 10) @option opts [Integer] :page_offset Specific offset to use as the beginning of the returned page. (default to 0) @option opts [String] :filter A search query that filters services by name. @return [IncidentServicesResponse]
# File lib/datadog_api_client/v2/api/incident_services_api.rb, line 257 def list_incident_services(opts = {}) data, _status_code, _headers = list_incident_services_with_http_info(opts) data end
Get a list of all incident services Get all incident services uploaded for the requesting user's organization. If the `include` query parameter is provided, the included attribute will contain the users related to these incident services. @param [Hash] opts the optional parameters @option opts [IncidentRelatedObject] :include Specifies which types of related objects should be included in the response. @option opts [Integer] :page_size Size for a given page. @option opts [Integer] :page_offset Specific offset to use as the beginning of the returned page. @option opts [String] :filter A search query that filters services by name. @return [Array<(IncidentServicesResponse
, Integer, Hash)>] IncidentServicesResponse
data, response status code and response headers
# File lib/datadog_api_client/v2/api/incident_services_api.rb, line 270 def list_incident_services_with_http_info(opts = {}) if @api_client.config.unstable_operations.has_key?(:list_incident_services) unstable_enabled = @api_client.config.unstable_operations[:list_incident_services] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "list_incident_services") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_incident_services")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: IncidentServicesAPI.list_incident_services ...' end # resource path local_var_path = '/api/v2/services' # query parameters query_params = opts[:query_params] || {} query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil? query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].nil? query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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] || 'IncidentServicesResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] new_options = opts.merge( :operation => :list_incident_services, :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: IncidentServicesAPI#list_incident_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update an existing incident service Updates an existing incident service. Only provide the attributes which should be updated as this request is a partial update. @param service_id [String] The ID of the incident service. @param body [IncidentServiceUpdateRequest] Incident Service Payload. @param [Hash] opts the optional parameters @return [IncidentServiceResponse]
# File lib/datadog_api_client/v2/api/incident_services_api.rb, line 334 def update_incident_service(service_id, body, opts = {}) data, _status_code, _headers = update_incident_service_with_http_info(service_id, body, opts) data end
Update an existing incident service Updates an existing incident service. Only provide the attributes which should be updated as this request is a partial update. @param service_id [String] The ID of the incident service. @param body [IncidentServiceUpdateRequest] Incident Service Payload. @param [Hash] opts the optional parameters @return [Array<(IncidentServiceResponse
, Integer, Hash)>] IncidentServiceResponse
data, response status code and response headers
# File lib/datadog_api_client/v2/api/incident_services_api.rb, line 345 def update_incident_service_with_http_info(service_id, body, opts = {}) if @api_client.config.unstable_operations.has_key?(:update_incident_service) unstable_enabled = @api_client.config.unstable_operations[:update_incident_service] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "update_incident_service") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_incident_service")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: IncidentServicesAPI.update_incident_service ...' end # verify the required parameter 'service_id' is set if @api_client.config.client_side_validation && service_id.nil? fail ArgumentError, "Missing the required parameter 'service_id' when calling IncidentServicesAPI.update_incident_service" 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 IncidentServicesAPI.update_incident_service" end # resource path local_var_path = '/api/v2/services/{service_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_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] || 'IncidentServiceResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] new_options = opts.merge( :operation => :update_incident_service, :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(:PATCH, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: IncidentServicesAPI#update_incident_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end