putpolicy

Documentation

Overview

Create an enrich policy. Creates an enrich policy.

Index

• Variables
• type NewPutPolicy
  • func NewPutPolicyFunc(tp elastictransport.Interface) NewPutPolicy
• type PutPolicy
  • func New(tp elastictransport.Interface) *PutPolicy
  • func (r PutPolicy) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutPolicy) ErrorTrace(errortrace bool) *PutPolicy
  • func (r *PutPolicy) FilterPath(filterpaths ...string) *PutPolicy
  • func (r *PutPolicy) GeoMatch(geomatch *types.EnrichPolicy) *PutPolicy
  • func (r *PutPolicy) Header(key, value string) *PutPolicy
  • func (r *PutPolicy) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutPolicy) Human(human bool) *PutPolicy
  • func (r *PutPolicy) Match(match *types.EnrichPolicy) *PutPolicy
  • func (r PutPolicy) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutPolicy) Pretty(pretty bool) *PutPolicy
  • func (r *PutPolicy) Range(range_ *types.EnrichPolicy) *PutPolicy
  • func (r *PutPolicy) Raw(raw io.Reader) *PutPolicy
  • func (r *PutPolicy) Request(req *Request) *PutPolicy
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, 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 NewPutPolicy

type NewPutPolicy func(name string) *PutPolicy

NewPutPolicy type alias for index.

func NewPutPolicyFunc

func NewPutPolicyFunc(tp elastictransport.Interface) NewPutPolicy

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

type PutPolicy

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

func New

func New(tp elastictransport.Interface) *PutPolicy

Create an enrich policy. Creates an enrich policy.

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

func (PutPolicy) Do

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

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

func (*PutPolicy) ErrorTrace

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

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

func (*PutPolicy) FilterPath

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

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

func (*PutPolicy) GeoMatch

func (r *PutPolicy) GeoMatch(geomatch *types.EnrichPolicy) *PutPolicy

GeoMatch Matches enrich data to incoming documents based on a `geo_shape` query. API name: geo_match

func (*PutPolicy) Header

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

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

func (*PutPolicy) HttpRequest

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

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

func (*PutPolicy) Human

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

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 (*PutPolicy) Match

func (r *PutPolicy) Match(match *types.EnrichPolicy) *PutPolicy

Match Matches enrich data to incoming documents based on a `term` query. API name: match

func (PutPolicy) Perform

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

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

func (*PutPolicy) Pretty

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

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

func (*PutPolicy) Range

func (r *PutPolicy) Range(range_ *types.EnrichPolicy) *PutPolicy

Range Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query. API name: range

func (*PutPolicy) Raw

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

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

func (*PutPolicy) Request

func (r *PutPolicy) Request(req *Request) *PutPolicy

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

type Request

type Request struct {

	// GeoMatch Matches enrich data to incoming documents based on a `geo_shape` query.
	GeoMatch *types.EnrichPolicy `json:"geo_match,omitempty"`
	// Match Matches enrich data to incoming documents based on a `term` query.
	Match *types.EnrichPolicy `json:"match,omitempty"`
	// Range Matches a number, date, or IP address in incoming documents to a range in the
	// enrich index based on a `term` query.
	Range *types.EnrichPolicy `json:"range,omitempty"`
}

Request holds the request body struct for the package putpolicy

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/enrich/put_policy/PutEnrichPolicyRequest.ts#L24-L53

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

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 putpolicy

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/enrich/put_policy/PutEnrichPolicyResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response