API Reference Snap v#0.13.0
View SourceModules
Snap is split into a few key modules
Represents an individual aggregation dictionary from a Search Aggregation API response.
Defines how HTTP request is transformed to add authentication.
Implements HTTP Basic Auth, if necessary.
Supports streaming bulk operations against a Snap.Cluster.
Represents a create step in a Snap.Bulk operation
Represents a delete step in a Snap.Bulk operation
Represents an index step in a Snap.Bulk operation
Represents an update step in a Snap.Bulk operation
Represents a list of errors, collected from a Snap.Bulk operation.
Defines a cluster.
Manages the namespacing of a cluster, so a cluster can be scoped to only operate on indexes with a specific prefix.
Represents the response from ElasticSearch's delete_by_query request.
Convenience API into the Document API.
Behaviour for the HTTP client used by the Snap.Cluster.
Built in adapter using Finch.
Represents an Error returned by the HTTPClient.
Response of a http request.
Represents an HTTP error returned while executing a query.
Represents an individual hit dictionary from a Search API response.
Represents the hits dictionary returned from an ElasticSearch Search API response.
Helper functions around index management.
Provides a high level abstraction over the Multi Search API which allows the user to perform multiple searches in a single request.
Represents a successful response for a Snap.Multi request.
Supports making arbitrary requests against Snap.Cluster.
Represents an Elasticsearch exception raised while executing a query.
Performs searches against an ElasticSearch cluster.
Represents the response from ElasticSearch's Search API.
Represents an individual suggest dictionary from a Search API response.
Represents an individual suggest / options dictionary from a Search API response.
Represents the suggest / options dictionary returned from an ElasticSearch Search API response.
Represents the suggest dictionary returned from an ElasticSearch Search API response.