Class: DataSift::HistoricsPreview

Inherits:
ApiResource show all
Defined in:
lib/historics_preview.rb

Overview

Methods for using DataSift Historics Previews

Constant Summary

Constants inherited from ApiResource

ApiResource::TLSv1, ApiResource::TLSv1_2

Constants included from DataSift

APPLICATION_JSON, DELETE, DETECT_DEAD_SOCKETS, GET, HEAD, IS_WINDOWS, KNOWN_SOCKETS, SOCKET_DETECTOR_TIMEOUT, VERSION, X_ANALYSIS_TASKS_QUEUED, X_ANALYSIS_TASKS_QUEUE_LIMIT, X_INSIGHT_TASKS_QUEUED, X_INSIGHT_TASKS_QUEUE_LIMIT, X_RATELIMIT_COST, X_RATELIMIT_LIMIT, X_RATELIMIT_REMAINING, X_TASKS_QUEUED, X_TASKS_QUEUE_LIMIT

Instance Method Summary collapse

Methods inherited from ApiResource

#initialize, #requires

Methods included from DataSift

#build_path, request

Constructor Details

This class inherits a constructor from DataSift::ApiResource

Instance Method Details

#create(hash, sources, parameters, start, end_time = nil) ⇒ Object

Create a new Historics Preview

Parameters:

  • hash (String) —

    Hash of compiled CSDL definition

  • sources (String) —

    Comma separated list of data sources you wish to perform this Historics Preview against

  • parameters (String) —

    Historics Preview parameters. See our /preview/create API Docs for full documentation

  • start (String) —

    Start timestamp for your Historics Preview. Should be provided as Unix timestamp

  • end_time (String) (defaults to: nil) —

    End timestamp for your Historics Preview. Should be provided as Unix timestamp



16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/historics_preview.rb', line 16

def create(hash, sources, parameters, start, end_time = nil)
  params = {
    :hash       => hash,
    :sources    => sources,
    :parameters => parameters,
    :start      => start
  }
  requires params
  params.merge!(:end => end_time) unless end_time.nil?

  DataSift.request(:POST, 'preview/create', @config, params)
end

#get(id) ⇒ Object

Retreive an Historics Preview

Parameters:

  • id (String) —

    ID of the Historics Preview



32
33
34
35
36
 
# File 'lib/historics_preview.rb', line 32

def get(id)
  params = { :id => id }
  requires params
  DataSift.request(:POST, 'preview/get', @config, params)
end