geoipstats

Documentation

Overview

Gets download statistics for GeoIP2 databases used with the geoip processor.

Index

• Variables
• type GeoIpStats
  • func New(tp elastictransport.Interface) *GeoIpStats
  • func (r GeoIpStats) Do(providedCtx context.Context) (*Response, error)
  • func (r *GeoIpStats) ErrorTrace(errortrace bool) *GeoIpStats
  • func (r *GeoIpStats) FilterPath(filterpaths ...string) *GeoIpStats
  • func (r *GeoIpStats) Header(key, value string) *GeoIpStats
  • func (r *GeoIpStats) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GeoIpStats) Human(human bool) *GeoIpStats
  • func (r GeoIpStats) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GeoIpStats) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GeoIpStats) Pretty(pretty bool) *GeoIpStats
• type NewGeoIpStats
  • func NewGeoIpStatsFunc(tp elastictransport.Interface) NewGeoIpStats
• type Response
  • func NewResponse() *Response

Variables

var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

ErrBuildPath is returned in case of missing parameters within the build of the request.

Types

type GeoIpStats

type GeoIpStats struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *GeoIpStats

Gets download statistics for GeoIP2 databases used with the geoip processor.

https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html

func (GeoIpStats) Do

func (r GeoIpStats) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a geoipstats.Response

func (*GeoIpStats) ErrorTrace

func (r *GeoIpStats) ErrorTrace(errortrace bool) *GeoIpStats

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*GeoIpStats) FilterPath

func (r *GeoIpStats) FilterPath(filterpaths ...string) *GeoIpStats

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*GeoIpStats) Header

func (r *GeoIpStats) Header(key, value string) *GeoIpStats

Header set a key, value pair in the GeoIpStats headers map.

func (*GeoIpStats) HttpRequest

func (r *GeoIpStats) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*GeoIpStats) Human

func (r *GeoIpStats) Human(human bool) *GeoIpStats

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (GeoIpStats) IsSuccess

func (r GeoIpStats) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (GeoIpStats) Perform

func (r GeoIpStats) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*GeoIpStats) Pretty

func (r *GeoIpStats) Pretty(pretty bool) *GeoIpStats

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

type NewGeoIpStats

type NewGeoIpStats func() *GeoIpStats

NewGeoIpStats type alias for index.

func NewGeoIpStatsFunc

func NewGeoIpStatsFunc(tp elastictransport.Interface) NewGeoIpStats

NewGeoIpStatsFunc returns a new instance of GeoIpStats with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Response

type Response struct {

	// Nodes Downloaded GeoIP2 databases for each node.
	Nodes map[string]types.GeoIpNodeDatabases `json:"nodes"`
	// Stats Download statistics for all GeoIP2 databases.
	Stats types.GeoIpDownloadStatistics `json:"stats"`
}

Response holds the response body struct for the package geoipstats

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/ingest/geo_ip_stats/IngestGeoIpStatsResponse.ts#L24-L31

func NewResponse

func NewResponse() *Response

NewResponse returns a Response