getgeoipdatabase

Documentation

Overview

Get GeoIP database configurations. Get information about one or more IP geolocation database configurations.

Index

• Variables
• type GetGeoipDatabase
  • func New(tp elastictransport.Interface) *GetGeoipDatabase
  • func (r GetGeoipDatabase) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetGeoipDatabase) ErrorTrace(errortrace bool) *GetGeoipDatabase
  • func (r *GetGeoipDatabase) FilterPath(filterpaths ...string) *GetGeoipDatabase
  • func (r *GetGeoipDatabase) Header(key, value string) *GetGeoipDatabase
  • func (r *GetGeoipDatabase) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetGeoipDatabase) Human(human bool) *GetGeoipDatabase
  • func (r *GetGeoipDatabase) Id(id string) *GetGeoipDatabase
  • func (r GetGeoipDatabase) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetGeoipDatabase) MasterTimeout(duration string) *GetGeoipDatabase
  • func (r GetGeoipDatabase) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetGeoipDatabase) Pretty(pretty bool) *GetGeoipDatabase
• type NewGetGeoipDatabase
  • func NewGetGeoipDatabaseFunc(tp elastictransport.Interface) NewGetGeoipDatabase
• 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 GetGeoipDatabase

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

func New

func New(tp elastictransport.Interface) *GetGeoipDatabase

Get GeoIP database configurations. Get information about one or more IP geolocation database configurations.

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-geoip-database-api.html

func (GetGeoipDatabase) Do

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

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

func (*GetGeoipDatabase) ErrorTrace

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

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

func (*GetGeoipDatabase) FilterPath

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

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

func (*GetGeoipDatabase) Header

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

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

func (*GetGeoipDatabase) HttpRequest

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

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

func (*GetGeoipDatabase) Human

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

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 (*GetGeoipDatabase) Id

func (r *GetGeoipDatabase) Id(id string) *GetGeoipDatabase

Id Comma-separated list of database configuration IDs to retrieve. Wildcard (`*`) expressions are supported. To get all database configurations, omit this parameter or use `*`. API Name: id

func (GetGeoipDatabase) IsSuccess

func (r GetGeoipDatabase) 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 (*GetGeoipDatabase) MasterTimeout

func (r *GetGeoipDatabase) MasterTimeout(duration string) *GetGeoipDatabase

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (GetGeoipDatabase) Perform

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

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

func (*GetGeoipDatabase) Pretty

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

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

type NewGetGeoipDatabase

type NewGetGeoipDatabase func() *GetGeoipDatabase

NewGetGeoipDatabase type alias for index.

func NewGetGeoipDatabaseFunc

func NewGetGeoipDatabaseFunc(tp elastictransport.Interface) NewGetGeoipDatabase

NewGetGeoipDatabaseFunc returns a new instance of GetGeoipDatabase 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 {
	Databases []types.DatabaseConfigurationMetadata `json:"databases"`
}

Response holds the response body struct for the package getgeoipdatabase

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ingest/get_geoip_database/GetGeoipDatabaseResponse.ts#L25-L27

func NewResponse

func NewResponse() *Response

NewResponse returns a Response