query.setPath()

SaltwaterC edited this page Jan 20, 2012 · 3 revisions

About

Helper method for setting the HTTP path.

Reference

query.setPath([path])
  • 'path' - HTTP path for the API call. Defaults to '/' if unspecified or invalid, therefore is an optional argument.

Since all the clients use the POST HTTP method, the path defaults to '/'. Under normal circumstances, just sqs.setQueue() changes the default path, therefore it has its usage for this specific client only if you would like to reset the path for a specific queue. However, it is exposed for all the query API clients, therefore what you do with this helper is your choice.

This method is chainable (aka it returns the client object).