deleteiplocationdatabase

Documentation

Overview

Delete IP geolocation database configurations.

Index

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

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

func New

func New(tp elastictransport.Interface) *DeleteIpLocationDatabase

Delete IP geolocation database configurations.

https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-ip-location-database-api.html

func (DeleteIpLocationDatabase) Do

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

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

func (*DeleteIpLocationDatabase) ErrorTrace

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

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

func (*DeleteIpLocationDatabase) FilterPath

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

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

func (*DeleteIpLocationDatabase) Header

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

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

func (*DeleteIpLocationDatabase) HttpRequest

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

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

func (*DeleteIpLocationDatabase) Human

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

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

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

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

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 (DeleteIpLocationDatabase) Perform

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

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

func (*DeleteIpLocationDatabase) Pretty

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

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

func (*DeleteIpLocationDatabase) Timeout

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

Timeout The period to wait for a response. 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: timeout

type NewDeleteIpLocationDatabase

type NewDeleteIpLocationDatabase func(id string) *DeleteIpLocationDatabase

NewDeleteIpLocationDatabase type alias for index.

func NewDeleteIpLocationDatabaseFunc

func NewDeleteIpLocationDatabaseFunc(tp elastictransport.Interface) NewDeleteIpLocationDatabase

NewDeleteIpLocationDatabaseFunc returns a new instance of DeleteIpLocationDatabase 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 {

	// 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 deleteiplocationdatabase

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response