putpolicy

Documentation

Overview

Creates a new enrich policy.

Index

• Variables
• type NewPutPolicy
  • func NewPutPolicyFunc(tp elastictransport.Interface) NewPutPolicy
• type PutPolicy
  • func New(tp elastictransport.Interface) *PutPolicy
  • func (r PutPolicy) Do(ctx context.Context) (*http.Response, error)
  • func (r *PutPolicy) Header(key, value string) *PutPolicy
  • func (r *PutPolicy) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutPolicy) Name(v string) *PutPolicy
  • func (r *PutPolicy) Raw(raw json.RawMessage) *PutPolicy
  • func (r *PutPolicy) Request(req *Request) *PutPolicy
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) GeoMatch(geomatch *types.PolicyBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Match(match *types.PolicyBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Range_(range_ *types.PolicyBuilder) *RequestBuilder

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

Creates a new enrich policy.

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

func (PutPolicy) Do

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

Do runs the http.Request through the provided transport.

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) Name

func (r *PutPolicy) Name(v string) *PutPolicy

Name The name of the enrich policy API Name: name

func (*PutPolicy) Raw

func (r *PutPolicy) Raw(raw json.RawMessage) *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 *types.Policy `json:"geo_match,omitempty"`

	Match *types.Policy `json:"match,omitempty"`

	Range *types.Policy `json:"range,omitempty"`
}

Request holds the request body struct for the package putpolicy

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/enrich/put_policy/PutEnrichPolicyRequest.ts#L24-L38

type RequestBuilder

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

RequestBuilder is the builder API for the putpolicy.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) GeoMatch

func (rb *RequestBuilder) GeoMatch(geomatch *types.PolicyBuilder) *RequestBuilder

func (*RequestBuilder) Match

func (rb *RequestBuilder) Match(match *types.PolicyBuilder) *RequestBuilder

func (*RequestBuilder) Range_

func (rb *RequestBuilder) Range_(range_ *types.PolicyBuilder) *RequestBuilder