getpolicy

Documentation

Overview

Get an enrich policy. Returns information about an enrich policy.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetPolicy

Get an enrich policy. Returns information about an enrich policy.

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

func (GetPolicy) Do

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

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

func (*GetPolicy) ErrorTrace

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

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

func (*GetPolicy) FilterPath

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

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

func (*GetPolicy) Header

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

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

func (*GetPolicy) HttpRequest

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

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

func (*GetPolicy) Human

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

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

func (r GetPolicy) 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 (*GetPolicy) Name

func (r *GetPolicy) Name(name string) *GetPolicy

Name Comma-separated list of enrich policy names used to limit the request. To return information for all enrich policies, omit this parameter. API Name: name

func (GetPolicy) Perform

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

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

func (*GetPolicy) Pretty

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

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

type NewGetPolicy

type NewGetPolicy func() *GetPolicy

NewGetPolicy type alias for index.

func NewGetPolicyFunc

func NewGetPolicyFunc(tp elastictransport.Interface) NewGetPolicy

NewGetPolicyFunc returns a new instance of GetPolicy 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 {
	Policies []types.Summary `json:"policies"`
}

Response holds the response body struct for the package getpolicy

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/enrich/get_policy/GetEnrichPolicyResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response