Class: NexosisApi::Session

Inherits:
Object
  • Object
show all
Defined in:
lib/nexosis_api/session.rb

Overview

Class for parsing the results of a session based request

Direct Known Subclasses

SessionResponse, SessionResult

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sessionHash) ⇒ Session

Returns a new instance of Session.

[View source]

4
5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/nexosis_api/session.rb', line 4

def initialize(sessionHash)
	sessionHash.each do |k,v|
		if(k == "links")
			links = Array.new
			v.each do |l| links << NexosisApi::Link.new(l) end
			instance_variable_set("@#{k}", links) unless v.nil?
		elsif(k == "isEstimate")
                  instance_variable_set("@is_estimate", v) unless v.nil?
		else
			instance_variable_set("@#{k}", v) unless v.nil?
		end
	end
end

Instance Attribute Details

#dataSetName ⇒ String

the dataset used in this session

Returns:

  • (String) 

40
41
42
 
# File 'lib/nexosis_api/session.rb', line 40

def dataSetName
  @dataSetName
end

#endDate ⇒ DateTime

The end date of analysis in this session

Returns:

  • (DateTime) 

52
53
54
 
# File 'lib/nexosis_api/session.rb', line 52

def endDate
  @endDate
end

#extraParameters ⇒ Hash

reserved for future extensions

Returns:

  • (Hash) 

36
37
38
 
# File 'lib/nexosis_api/session.rb', line 36

def extraParameters
  @extraParameters
end

#is_estimate ⇒ Boolean

Is this session an estimate only session

Returns:

  • (Boolean) 

60
61
62
 
# File 'lib/nexosis_api/session.rb', line 60

def is_estimate
  @is_estimate
end

#links ⇒ Array of NexosisApi::Link

associated hypermedia

Returns:


56
57
58
 
# File 'lib/nexosis_api/session.rb', line 56

def links
  @links
end

#sessionId ⇒ String

identifier for this sesssion

Returns:

  • (String) 

20
21
22
 
# File 'lib/nexosis_api/session.rb', line 20

def sessionId
  @sessionId
end

#startDate ⇒ DateTime

The start date of analysis in this session

Returns:

  • (DateTime) 

48
49
50
 
# File 'lib/nexosis_api/session.rb', line 48

def startDate
  @startDate
end

#status ⇒ String

Is this session requested, estimated, started, or completed

Returns:

  • (String) 

28
29
30
 
# File 'lib/nexosis_api/session.rb', line 28

def status
  @status
end

#statusHistory ⇒ Hash

Date and status of each status this session has entered

Returns:

  • (Hash) 

32
33
34
 
# File 'lib/nexosis_api/session.rb', line 32

def statusHistory
  @statusHistory
end

#targetColumn ⇒ String

The column in the dataset for which this session ran predictions

Returns:

  • (String) 

44
45
46
 
# File 'lib/nexosis_api/session.rb', line 44

def targetColumn
  @targetColumn
end

#type ⇒ String

What type of analysis was run during this session

Returns:

  • (String) 

24
25
26
 
# File 'lib/nexosis_api/session.rb', line 24

def type
  @type
end