Documentation
¶
Overview ¶
Create or update an IP geolocation database configuration.
Index ¶
- Variables
- type NewPutIpLocationDatabase
- type PutIpLocationDatabase
- func (r PutIpLocationDatabase) Do(providedCtx context.Context) (*Response, error)
- func (r *PutIpLocationDatabase) ErrorTrace(errortrace bool) *PutIpLocationDatabase
- func (r *PutIpLocationDatabase) FilterPath(filterpaths ...string) *PutIpLocationDatabase
- func (r *PutIpLocationDatabase) Header(key, value string) *PutIpLocationDatabase
- func (r *PutIpLocationDatabase) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PutIpLocationDatabase) Human(human bool) *PutIpLocationDatabase
- func (r *PutIpLocationDatabase) Ipinfo(ipinfo *types.Ipinfo) *PutIpLocationDatabase
- func (r *PutIpLocationDatabase) MasterTimeout(duration string) *PutIpLocationDatabase
- func (r *PutIpLocationDatabase) Maxmind(maxmind *types.Maxmind) *PutIpLocationDatabase
- func (r *PutIpLocationDatabase) Name(name string) *PutIpLocationDatabase
- func (r PutIpLocationDatabase) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PutIpLocationDatabase) Pretty(pretty bool) *PutIpLocationDatabase
- func (r *PutIpLocationDatabase) Raw(raw io.Reader) *PutIpLocationDatabase
- func (r *PutIpLocationDatabase) Request(req *Request) *PutIpLocationDatabase
- func (r *PutIpLocationDatabase) Timeout(duration string) *PutIpLocationDatabase
- type Request
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type NewPutIpLocationDatabase ¶
type NewPutIpLocationDatabase func(id string) *PutIpLocationDatabase
NewPutIpLocationDatabase type alias for index.
func NewPutIpLocationDatabaseFunc ¶
func NewPutIpLocationDatabaseFunc(tp elastictransport.Interface) NewPutIpLocationDatabase
NewPutIpLocationDatabaseFunc returns a new instance of PutIpLocationDatabase with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PutIpLocationDatabase ¶
type PutIpLocationDatabase struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PutIpLocationDatabase
Create or update an IP geolocation database configuration.
https://www.elastic.co/guide/en/elasticsearch/reference/current/put-ip-location-database-api.html
func (PutIpLocationDatabase) Do ¶
func (r PutIpLocationDatabase) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a putiplocationdatabase.Response
func (*PutIpLocationDatabase) ErrorTrace ¶
func (r *PutIpLocationDatabase) ErrorTrace(errortrace bool) *PutIpLocationDatabase
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*PutIpLocationDatabase) FilterPath ¶
func (r *PutIpLocationDatabase) FilterPath(filterpaths ...string) *PutIpLocationDatabase
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*PutIpLocationDatabase) Header ¶
func (r *PutIpLocationDatabase) Header(key, value string) *PutIpLocationDatabase
Header set a key, value pair in the PutIpLocationDatabase headers map.
func (*PutIpLocationDatabase) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutIpLocationDatabase) Human ¶
func (r *PutIpLocationDatabase) Human(human bool) *PutIpLocationDatabase
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 (*PutIpLocationDatabase) Ipinfo ¶
func (r *PutIpLocationDatabase) Ipinfo(ipinfo *types.Ipinfo) *PutIpLocationDatabase
API name: ipinfo
func (*PutIpLocationDatabase) MasterTimeout ¶
func (r *PutIpLocationDatabase) MasterTimeout(duration string) *PutIpLocationDatabase
MasterTimeout The 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. A value of `-1` indicates that the request should never time out. API name: master_timeout
func (*PutIpLocationDatabase) Maxmind ¶
func (r *PutIpLocationDatabase) Maxmind(maxmind *types.Maxmind) *PutIpLocationDatabase
API name: maxmind
func (*PutIpLocationDatabase) Name ¶
func (r *PutIpLocationDatabase) Name(name string) *PutIpLocationDatabase
Name The provider-assigned name of the IP geolocation database to download. API name: name
func (PutIpLocationDatabase) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PutIpLocationDatabase) Pretty ¶
func (r *PutIpLocationDatabase) Pretty(pretty bool) *PutIpLocationDatabase
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*PutIpLocationDatabase) Raw ¶
func (r *PutIpLocationDatabase) Raw(raw io.Reader) *PutIpLocationDatabase
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*PutIpLocationDatabase) Request ¶
func (r *PutIpLocationDatabase) Request(req *Request) *PutIpLocationDatabase
Request allows to set the request property with the appropriate payload.
func (*PutIpLocationDatabase) Timeout ¶
func (r *PutIpLocationDatabase) Timeout(duration string) *PutIpLocationDatabase
Timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. A value of `-1` indicates that the request should never time out. API name: timeout
type Request ¶
type Request = types.DatabaseConfiguration
Request holds the request body struct for the package putiplocationdatabase
Source Files
