Categorygithub.com/Bofry/elasticsearch-esresponse/v7
modulepackage
7.0.0
Repository: https://github.com/bofry/elasticsearch-esresponse.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrorReason returns the reason of an error that Elasticsearch reported, if err is of kind Error and has ErrorDetails with a Reason.
IsConflict returns true if the given error indicates that the Elasticsearch operation resulted in a version conflict.
IsConnErr returns true if the error indicates that Elastic could not find an Elasticsearch host to connect to.
IsContextErr returns true if the error is from a context that was canceled or deadline exceeded.
IsForbidden returns true if the given error indicates that Elasticsearch returned HTTP status 403.
IsNotFound returns true if the given error indicates that Elasticsearch returned HTTP status 404.
IsStatusCode returns true if the given error indicates that the Elasticsearch operation returned the specified HTTP status code.
IsTimeout returns true if the given error indicates that Elasticsearch returned HTTP status 408.
IsUnauthorized returns true if the given error indicates that Elasticsearch returned HTTP status 401.

# Variables

ErrBulkItemRetry is returned in BulkProcessor from a worker when a response item needs to be retried.
ErrNoClient is raised when no Elasticsearch node is available.
ErrResponseSize is raised if a response body exceeds the given max body size.
ErrRetry is raised when a request cannot be executed after the configured number of retries.
ErrTimeout is raised when a request timed out, e.g.

# Structs

AggregationBucketAdjacencyMatrix is a multi-bucket aggregation that is returned with a AdjacencyMatrix aggregation.
AggregationBucketCompositeItem is a single bucket of an AggregationBucketCompositeItems structure.
AggregationBucketCompositeItems implements the response structure for a bucket aggregation of type composite.
AggregationBucketFilters is a multi-bucket aggregation that is returned with a filters aggregation.
AggregationBucketHistogramItem is a single bucket of an AggregationBucketHistogramItems structure.
AggregationBucketHistogramItems is a bucket aggregation that is returned with a date histogram aggregation.
AggregationBucketKeyedHistogramItems is a bucket aggregation that is returned with a (keyed) date histogram aggregation.
AggregationBucketKeyedRangeItems is a bucket aggregation that is e.g.
AggregationBucketKeyItem is a single bucket of an AggregationBucketKeyItems structure.
AggregationBucketKeyItems is a bucket aggregation that is e.g.
AggregationBucketRangeItem is a single bucket of an AggregationBucketRangeItems structure.
AggregationBucketRangeItems is a bucket aggregation that is e.g.
AggregationBucketSignificantTerm is a single bucket of an AggregationBucketSignificantTerms structure.
AggregationBucketSignificantTerms is a bucket aggregation returned with a significant terms aggregation.
AggregationExtendedStatsMetric is a multi-value metric, returned by an ExtendedStats aggregation.
AggregationGeoBoundsMetric is a metric as returned by a GeoBounds aggregation.
AggregationGeoCentroidMetric is a metric as returned by a GeoCentroid aggregation.
AggregationMatrixStats is returned by a MatrixStats aggregation.
AggregationMatrixStatsField represents running stats of a single field returned from MatrixStats aggregation.
AggregationPercentilesMetric is a multi-value metric, returned by a Percentiles aggregation.
AggregationPipelineBucketMetricValue is a value returned e.g.
AggregationPipelineDerivative is the value returned by a Derivative aggregation.
AggregationPipelinePercentilesMetric is the value returned by a pipeline percentiles Metric aggregation.
AggregationPipelineSimpleValue is a simple value, returned e.g.
AggregationPipelineStatsMetric is a simple value, returned e.g.
AggregationScriptedMetric is the value return by a scripted metric aggregation.
AggregationSingleBucket is a single bucket, returned e.g.
AggregationStatsMetric is a multi-value metric, returned by a Stats aggregation.
AggregationTopHitsMetric is a metric returned by a TopHits aggregation.
AggregationValueMetric is a single-value metric, returned e.g.
CollectorResult holds the profile timings of the collectors used in the search.
CountResult is the result of a count in Elasticsearch.
No description provided by the author
Error encapsulates error details as returned from Elasticsearch.
ErrorDetails encapsulate error details from Elasticsearch.
No description provided by the author
No description provided by the author
NestedHit is a nested innerhit.
ProfileResult is the internal representation of a profiled query, corresponding to a single node in the query tree.
QueryProfileShardResult is a container class to hold the profile results for a single shard in the request.
ScriptErrorPosition specifies the position of the error in a script.
SearchExplanation explains how the score for a hit was computed.
SearchHit is a single hit.
SearchHitInnerHits is used for inner hits.
SearchHits specifies the list of search hits.
SearchProfile is a list of shard profiling data collected during query execution in the "profile" section of a SearchResult.
SearchProfileShardResult returns the profiling data for a single shard accessed during the search query or aggregation.
SearchResult is the result of a search in Elasticsearch.
SearchResultCluster holds information about a search response from a cluster.
SearchSuggestion is a single search suggestion.
SearchSuggestionOption is an option of a SearchSuggestion.
ShardFailure represents details about a failure.
ShardsInfo represents information from a shard.
TotalHits specifies total number of hits and its relation.

# Interfaces

Aggregations can be seen as a unit-of-work that build analytic information over a set of documents.

# Type aliases

Aggregations is a list of aggregations that are part of a search result.
SearchHitHighlight is the highlight information of a search hit.
SearchSuggest is a map of suggestions.