Class: Mediaflux::QueryRequest

Inherits:
Request
  • Object
show all
Defined in:
app/models/mediaflux/query_request.rb

Instance Attribute Summary collapse

Attributes inherited from Request

#session_token

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Request

build_post_request, default_xml_namespace, default_xml_namespace_uri, #error?, find_or_create_http_client, format_date_for_mediaflux, new_project_request_path, #resolve, #resolved?, #response_body, #response_error, #response_xml, uri, #xml_payload, #xtoshell_xml

Constructor Details

#initialize(session_token:, aql_query: nil, collection: nil, action: "get-values", deep_search: false, iterator: true, include_path: true) ⇒ QueryRequest

Constructor

Parameters:

  • session_token (String) —

    the API token for the authenticated session

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

    Optional AQL query string

  • collection (Integer) (defaults to: nil) —

    Optional collection id

  • action (String) (defaults to: "get-values") —

    Optional, by default it uses get-name but it could also be get-meta to get all the fields for the assets or ‘get-values` to get a limited list of fields.

  • deep_search (Bool) (defaults to: false) —

    Optional, false by default. When true queries the collection and it subcollections.

  • iterator (Bool) (defaults to: true) —

    Optional, true by default. When true returns an iterator. When false returns a list of results

  • include_path (Bool) (defaults to: true) —

    Optional, true by default, When true we include the ‘path` in the list of fields we fetch.



15
16
17
18
19
20
21
22
23
 
# File 'app/models/mediaflux/query_request.rb', line 15

def initialize(session_token:, aql_query: nil, collection: nil, action: "get-values", deep_search: false, iterator: true, include_path: true)
  super(session_token: session_token)
  @aql_query = aql_query
  @collection = collection
  @action = action
  @deep_search = deep_search
  @iterator = iterator
  @include_path = include_path
end

Instance Attribute Details

#action ⇒ Object (readonly)

Returns the value of attribute action.



4
5
6
 
# File 'app/models/mediaflux/query_request.rb', line 4

def action
  @action
end

#aql_query ⇒ Object (readonly)

Returns the value of attribute aql_query.



4
5
6
 
# File 'app/models/mediaflux/query_request.rb', line 4

def aql_query
  @aql_query
end

#collection ⇒ Object (readonly)

Returns the value of attribute collection.



4
5
6
 
# File 'app/models/mediaflux/query_request.rb', line 4

def collection
  @collection
end

#deep_search ⇒ Object (readonly)

Returns the value of attribute deep_search.



4
5
6
 
# File 'app/models/mediaflux/query_request.rb', line 4

def deep_search
  @deep_search
end

#iterator ⇒ Object (readonly)

Returns the value of attribute iterator.



4
5
6
 
# File 'app/models/mediaflux/query_request.rb', line 4

def iterator
  @iterator
end

Class Method Details

.service ⇒ String

Specifies the Mediaflux service to use when running a query

Returns:

  • (String) 


27
28
29
 
# File 'app/models/mediaflux/query_request.rb', line 27

def self.service
  "asset.query"
end

Instance Method Details

#result ⇒ Object

Returns the iterator that could be used to fetch the data



32
33
34
35
 
# File 'app/models/mediaflux/query_request.rb', line 32

def result
  xml = response_xml
  xml.xpath("/response/reply/result/iterator").text.to_i
end