API Reference Snap v0.7.0

modules

Modules

Snap is split into 3 main components

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.

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.

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.