class DatadogAPIClient::V2::IncidentsAPI

Attributes

api_client[RW]

Public Class Methods

new(api_client = APIClient.default) click to toggle source
# File lib/datadog_api_client/v2/api/incidents_api.rb, line 22
def initialize(api_client = APIClient.default)
  @api_client = api_client
end

Public Instance Methods

create_incident(body, opts = {}) click to toggle source

Create an incident Create an incident. @param body [IncidentCreateRequest] Incident payload. @param [Hash] opts the optional parameters @return [IncidentResponse]

# File lib/datadog_api_client/v2/api/incidents_api.rb, line 30
def create_incident(body, opts = {})
  data, _status_code, _headers = create_incident_with_http_info(body, opts)
  data
end
create_incident_with_http_info(body, opts = {}) click to toggle source

Create an incident Create an incident. @param body [IncidentCreateRequest] Incident payload. @param [Hash] opts the optional parameters @return [Array<(IncidentResponse, Integer, Hash)>] IncidentResponse data, response status code and response headers

# File lib/datadog_api_client/v2/api/incidents_api.rb, line 40
def create_incident_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:create_incident)
    unstable_enabled = @api_client.config.unstable_operations[:create_incident]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "create_incident")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_incident"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.create_incident ...'
  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 IncidentsAPI.create_incident"
  end
  # resource path
  local_var_path = '/api/v2/incidents'

  # 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] || 'IncidentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_incident,
    :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: IncidentsAPI#create_incident\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_incident(incident_id, opts = {}) click to toggle source

Delete an existing incident Deletes an existing incident from the users organization. @param incident_id [String] The UUID the incident. @param [Hash] opts the optional parameters @return [nil]

# File lib/datadog_api_client/v2/api/incidents_api.rb, line 105
def delete_incident(incident_id, opts = {})
  delete_incident_with_http_info(incident_id, opts)
  nil
end
delete_incident_with_http_info(incident_id, opts = {}) click to toggle source

Delete an existing incident Deletes an existing incident from the users organization. @param incident_id [String] The UUID the incident. @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/incidents_api.rb, line 115
def delete_incident_with_http_info(incident_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:delete_incident)
    unstable_enabled = @api_client.config.unstable_operations[:delete_incident]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_incident")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_incident"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.delete_incident ...'
  end
  # verify the required parameter 'incident_id' is set
  if @api_client.config.client_side_validation && incident_id.nil?
    fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsAPI.delete_incident"
  end
  # resource path
  local_var_path = '/api/v2/incidents/{incident_id}'.sub('{' + 'incident_id' + '}', CGI.escape(incident_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,
    :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: IncidentsAPI#delete_incident\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_incident(incident_id, opts = {}) click to toggle source

Get the details of an incident Get the details of an incident by `incident_id`. @param incident_id [String] The UUID the incident. @param [Hash] opts the optional parameters @option opts [Array<IncidentRelatedObject>] :include Specifies which types of related objects should be included in the response. @return [IncidentResponse]

# File lib/datadog_api_client/v2/api/incidents_api.rb, line 179
def get_incident(incident_id, opts = {})
  data, _status_code, _headers = get_incident_with_http_info(incident_id, opts)
  data
end
get_incident_with_http_info(incident_id, opts = {}) click to toggle source

Get the details of an incident Get the details of an incident by &#x60;incident_id&#x60;. @param incident_id [String] The UUID the incident. @param [Hash] opts the optional parameters @option opts [Array<IncidentRelatedObject>] :include Specifies which types of related objects should be included in the response. @return [Array<(IncidentResponse, Integer, Hash)>] IncidentResponse data, response status code and response headers

# File lib/datadog_api_client/v2/api/incidents_api.rb, line 190
def get_incident_with_http_info(incident_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:get_incident)
    unstable_enabled = @api_client.config.unstable_operations[:get_incident]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "get_incident")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_incident"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.get_incident ...'
  end
  # verify the required parameter 'incident_id' is set
  if @api_client.config.client_side_validation && incident_id.nil?
    fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsAPI.get_incident"
  end
  # resource path
  local_var_path = '/api/v2/incidents/{incident_id}'.sub('{' + 'incident_id' + '}', CGI.escape(incident_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) 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] || 'IncidentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_incident,
    :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: IncidentsAPI#get_incident\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_incidents(opts = {}) click to toggle source

Get a list of incidents Get all incidents for the user's organization. @param [Hash] opts the optional parameters @option opts [Array<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) @return [IncidentsResponse]

# File lib/datadog_api_client/v2/api/incidents_api.rb, line 256
def list_incidents(opts = {})
  data, _status_code, _headers = list_incidents_with_http_info(opts)
  data
end
list_incidents_with_http_info(opts = {}) click to toggle source

Get a list of incidents Get all incidents for the user&#39;s organization. @param [Hash] opts the optional parameters @option opts [Array<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. @return [Array<(IncidentsResponse, Integer, Hash)>] IncidentsResponse data, response status code and response headers

# File lib/datadog_api_client/v2/api/incidents_api.rb, line 268
def list_incidents_with_http_info(opts = {})

  if @api_client.config.unstable_operations.has_key?(:list_incidents)
    unstable_enabled = @api_client.config.unstable_operations[:list_incidents]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "list_incidents")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_incidents"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.list_incidents ...'
  end
  # resource path
  local_var_path = '/api/v2/incidents'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) 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?

  # 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] || 'IncidentsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_incidents,
    :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: IncidentsAPI#list_incidents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_incident(incident_id, body, opts = {}) click to toggle source

Update an existing incident Updates an incident. Provide only the attributes that should be updated as this request is a partial update. @param incident_id [String] The UUID the incident. @param body [IncidentUpdateRequest] Incident Payload. @param [Hash] opts the optional parameters @return [IncidentResponse]

# File lib/datadog_api_client/v2/api/incidents_api.rb, line 331
def update_incident(incident_id, body, opts = {})
  data, _status_code, _headers = update_incident_with_http_info(incident_id, body, opts)
  data
end
update_incident_with_http_info(incident_id, body, opts = {}) click to toggle source

Update an existing incident Updates an incident. Provide only the attributes that should be updated as this request is a partial update. @param incident_id [String] The UUID the incident. @param body [IncidentUpdateRequest] Incident Payload. @param [Hash] opts the optional parameters @return [Array<(IncidentResponse, Integer, Hash)>] IncidentResponse data, response status code and response headers

# File lib/datadog_api_client/v2/api/incidents_api.rb, line 342
def update_incident_with_http_info(incident_id, body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:update_incident)
    unstable_enabled = @api_client.config.unstable_operations[:update_incident]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "update_incident")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_incident"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.update_incident ...'
  end
  # verify the required parameter 'incident_id' is set
  if @api_client.config.client_side_validation && incident_id.nil?
    fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsAPI.update_incident"
  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 IncidentsAPI.update_incident"
  end
  # resource path
  local_var_path = '/api/v2/incidents/{incident_id}'.sub('{' + 'incident_id' + '}', CGI.escape(incident_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] || 'IncidentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_incident,
    :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: IncidentsAPI#update_incident\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end