putgeoipdatabase

Documentation

Overview

Create or update GeoIP database configurations. Create or update IP geolocation database configurations.

Index

• Variables
• type NewPutGeoipDatabase
  • func NewPutGeoipDatabaseFunc(tp elastictransport.Interface) NewPutGeoipDatabase
• type PutGeoipDatabase
  • func New(tp elastictransport.Interface) *PutGeoipDatabase
  • func (r PutGeoipDatabase) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutGeoipDatabase) ErrorTrace(errortrace bool) *PutGeoipDatabase
  • func (r *PutGeoipDatabase) FilterPath(filterpaths ...string) *PutGeoipDatabase
  • func (r *PutGeoipDatabase) Header(key, value string) *PutGeoipDatabase
  • func (r *PutGeoipDatabase) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutGeoipDatabase) Human(human bool) *PutGeoipDatabase
  • func (r *PutGeoipDatabase) MasterTimeout(duration string) *PutGeoipDatabase
  • func (r *PutGeoipDatabase) Maxmind(maxmind *types.Maxmind) *PutGeoipDatabase
  • func (r *PutGeoipDatabase) Name(name string) *PutGeoipDatabase
  • func (r PutGeoipDatabase) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutGeoipDatabase) Pretty(pretty bool) *PutGeoipDatabase
  • func (r *PutGeoipDatabase) Raw(raw io.Reader) *PutGeoipDatabase
  • func (r *PutGeoipDatabase) Request(req *Request) *PutGeoipDatabase
  • func (r *PutGeoipDatabase) Timeout(duration string) *PutGeoipDatabase
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• 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 NewPutGeoipDatabase

type NewPutGeoipDatabase func(id string) *PutGeoipDatabase

NewPutGeoipDatabase type alias for index.

func NewPutGeoipDatabaseFunc

func NewPutGeoipDatabaseFunc(tp elastictransport.Interface) NewPutGeoipDatabase

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

type PutGeoipDatabase

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

func New

func New(tp elastictransport.Interface) *PutGeoipDatabase

Create or update GeoIP database configurations. Create or update IP geolocation database configurations.

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

func (PutGeoipDatabase) Do

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

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

func (*PutGeoipDatabase) ErrorTrace

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

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

func (*PutGeoipDatabase) FilterPath

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

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

func (*PutGeoipDatabase) Header

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

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

func (*PutGeoipDatabase) HttpRequest

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

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

func (*PutGeoipDatabase) Human

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

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 (*PutGeoipDatabase) MasterTimeout

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

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 (*PutGeoipDatabase) Maxmind

func (r *PutGeoipDatabase) Maxmind(maxmind *types.Maxmind) *PutGeoipDatabase

Maxmind The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading. At present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured. API name: maxmind

func (*PutGeoipDatabase) Name

func (r *PutGeoipDatabase) Name(name string) *PutGeoipDatabase

Name The provider-assigned name of the IP geolocation database to download. API name: name

func (PutGeoipDatabase) Perform

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

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

func (*PutGeoipDatabase) Pretty

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

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

func (*PutGeoipDatabase) Raw

func (r *PutGeoipDatabase) Raw(raw io.Reader) *PutGeoipDatabase

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*PutGeoipDatabase) Request

func (r *PutGeoipDatabase) Request(req *Request) *PutGeoipDatabase

Request allows to set the request property with the appropriate payload.

func (*PutGeoipDatabase) Timeout

func (r *PutGeoipDatabase) Timeout(duration string) *PutGeoipDatabase

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

type Request

type Request struct {

	// Maxmind The configuration necessary to identify which IP geolocation provider to use
	// to download the database, as well as any provider-specific configuration
	// necessary for such downloading.
	// At present, the only supported provider is maxmind, and the maxmind provider
	// requires that an account_id (string) is configured.
	Maxmind types.Maxmind `json:"maxmind"`
	// Name The provider-assigned name of the IP geolocation database to download.
	Name string `json:"name"`
}

Request holds the request body struct for the package putgeoipdatabase

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts#L25-L58

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package putgeoipdatabase

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ingest/put_geoip_database/PutGeoipDatabaseResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response