class NexosisApi::SessionListQuery

class to hold the query options for list datasets @since 3.0.0 @see developers.nexosis.com/docs/services/98847a3fbbe64f73aa959d3cededb3af/operations/sessions-list-all? @note sort by properties include id, name, type, status, dataSourceName, and requestedDate

Attributes

datasource_name[RW]

Limits sessions to those for a particular data source @return [String]

event_name[RW]

Limits impact sessions to those for a particular event @return [String]

model_id[RW]

Limits model-building sessions to those that built the specified model @return [String]

requested_after_date[RW]

Format - date-time (as date-time in ISO8601). Limits sessions to those requested on or after the specified date @return [String]

requested_before_date[RW]

Format - date-time (as date-time in ISO8601). Limits sessions to those requested on or before the specified date @return [String]

Public Class Methods

new(options = {}) click to toggle source
Calls superclass method NexosisApi::ListQuery::new
# File lib/nexosis_api/list_queries.rb, line 87
def initialize(options = {})
  @datasource_name = options[:datasource_name] if options.key? :datasource_name
  @event_name = options[:event_name] if options.key? :event_name
  @model_id = options[:model_id] if options.key? :model_id
  @requested_after_date = options[:requested_after_date] if options.key? :requested_after_date
  @requested_before_date = options[:requested_before_date] if options.key? :requested_before_date
  super(options, :datasource_name, :event_name, :model_id, :requested_after_date, :requested_before_date)
end

Public Instance Methods

query_parameters() click to toggle source

A hash suitable for using as the query portion of an HTTP request to the API @return [Hash]

# File lib/nexosis_api/list_queries.rb, line 98
def query_parameters
  parm_hash = {}
  parm_hash.store(:dataSourceName, @datasource_name) unless @datasource_name.nil?
  parm_hash.store(:eventName, @event_name) unless @event_name.nil?
  parm_hash.store(:modelId, @model_id) unless @model_id.nil?
  parm_hash.store(:requestedAfterDate, date_string(@requested_after_date)) unless @requested_after_date.nil?
  parm_hash.store(:requestedBeforeDate, date_string(@requested_before_date)) unless @requested_before_date.nil?
  self.to_hash.merge(parm_hash)
end