module BWAPI::Client::Projects::Queries::Backfill

Backfill module for projects/queries/backfill endpoints

Public Instance Methods

backfills(project_id, query_id, opts = {}) click to toggle source

Get all backfills for query

@param project_id [Integer] Id of project @param query_id [Integer] Id of query @param opts [Hash] options hash of parameters @option opts [Integer] page Page of results to retrieve @option opts [Integer] pageSize Results per page @return [Hash] All backfills for query

# File lib/bwapi/client/projects/queries/backfill.rb, line 15
def backfills(project_id, query_id, opts = {})
  get "projects/#{project_id}/queries/#{query_id}/backfill", opts
end
create_backfill(project_id, query_id, opts = {}) click to toggle source

Create new backfill for query

@param project_id [Integer] Id of project @param query_id [Integer] Id of query @param opts [Hash] options hash of parameters @option opts [Integer] projectId Id of the project @option opts [Integer] queryId Id of the query @option opts [Integer] id Id of the backfill @option opts [Integer] mentionsFound Mentions found from the backfill @option opts [Date] maxDate Max date for the backfill @option opts [Date] minDate Min date for the backfill @option opts [String] status Status of backfill @option opts [Integer] queryId Query id of backfill @option opts [String] statusMessages Current status message of backfill @return [Hash] New backfill for query

# File lib/bwapi/client/projects/queries/backfill.rb, line 44
def create_backfill(project_id, query_id, opts = {})
  post "projects/#{project_id}/queries/#{query_id}/backfill", opts
end
delete_backfill(project_id, query_id, backfill_id) click to toggle source

Delete backfill for query

@param project_id [Integer] Id of project @param query_id [Integer] Id of query @param backfill_id [Integer] Id of backfill @return [Hash] Deleted backfill for query

# File lib/bwapi/client/projects/queries/backfill.rb, line 54
def delete_backfill(project_id, query_id, backfill_id)
  delete "projects/#{project_id}/queries/#{query_id}/backfill/#{backfill_id}"
end
get_backfill(project_id, query_id, backfill_id) click to toggle source

Get specific backfill for query

@param project_id [Integer] Id of project @param query_id [Integer] Id of query @param backfill_id [Integer] Id of backfill @return [Hash] Backfill for query

# File lib/bwapi/client/projects/queries/backfill.rb, line 25
def get_backfill(project_id, query_id, backfill_id)
  get "projects/#{project_id}/queries/#{query_id}/backfill/#{backfill_id}"
end