putpolicy

package
v8.13.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2024 License: Apache-2.0 Imports: 11 Imported by: 3

Documentation

Overview

Creates a new enrich policy.

Index

Constants

This section is empty.

Variables

View Source
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 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 (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) GeoMatch added in v8.9.0

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) Match added in v8.9.0

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 added in v8.7.0

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) Range added in v8.9.0

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/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/enrich/put_policy/PutEnrichPolicyRequest.ts#L24-L52

func NewRequest added in v8.5.0

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0

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

FromJSON allows to load an arbitrary json into the request structure

type Response added in v8.7.0

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/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/enrich/put_policy/PutEnrichPolicyResponse.ts#L22-L24

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL