Class: NexosisApi::DatasetListQuery

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

Overview

Note:

  • sort by properties include dataSetName, dataSetSize, rowCount, dateCreated, and lastModified

class to hold the query options for list datasets

See Also:

Since:

  • 3.0.0

Instance Attribute Summary collapse

Attributes inherited from ListQuery

#page_number, #page_size, #sort_by, #sort_order

Instance Method Summary collapse

Methods inherited from ListQuery

#to_hash

Constructor Details

#initialize(options = {}) ⇒ DatasetListQuery

Returns a new instance of DatasetListQuery.

Since:

  • 3.0.0



64
65
66
67
68
 
# File 'lib/nexosis_api/list_queries.rb', line 64

def initialize(options = {})
  
  @partial_name = options[:partial_name] if options.key? :partial_name
  super(options, :partial_name)
end

Instance Attribute Details

#partial_name ⇒ String

The name or part of a name by which to limit the list results.

Returns:

  • (String)

Since:

  • 3.0.0



79
80
81
 
# File 'lib/nexosis_api/list_queries.rb', line 79

def partial_name
  @partial_name
end

Instance Method Details

#query_parameters ⇒ Hash

A hash suitable for using as the query portion of an HTTP request to the API

Returns:

  • (Hash)

Since:

  • 3.0.0



72
73
74
75
76
 
# File 'lib/nexosis_api/list_queries.rb', line 72

def query_parameters
  parm_hash = {}
  parm_hash.store(:partialName, @partial_name) unless @partial_name.nil?
  self.to_hash.merge(parm_hash)
end