geoipstats

Documentation

Overview

Returns statistical information about geoip databases

Index

• Variables
• type GeoIpStats
  • func New(tp elastictransport.Interface) *GeoIpStats
  • func (r GeoIpStats) Do(ctx context.Context) (*Response, error)
  • func (r *GeoIpStats) Header(key, value string) *GeoIpStats
  • func (r *GeoIpStats) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r GeoIpStats) IsSuccess(ctx context.Context) (bool, error)
  • func (r GeoIpStats) Perform(ctx context.Context) (*http.Response, error)
• 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

Returns statistical information about geoip databases

https://www.elastic.co/guide/en/elasticsearch/reference/master/geoip-stats-api.html

func (GeoIpStats) Do

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

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

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) IsSuccess

func (r GeoIpStats) IsSuccess(ctx 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(ctx context.Context) (*http.Response, error)

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

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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response