Documentation
¶
Overview ¶
Run an enrich policy. Create the enrich index for an existing enrich policy.
Index ¶
- Variables
- type ExecutePolicy
- func (r ExecutePolicy) Do(providedCtx context.Context) (*Response, error)
- func (r *ExecutePolicy) ErrorTrace(errortrace bool) *ExecutePolicy
- func (r *ExecutePolicy) FilterPath(filterpaths ...string) *ExecutePolicy
- func (r *ExecutePolicy) Header(key, value string) *ExecutePolicy
- func (r *ExecutePolicy) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *ExecutePolicy) Human(human bool) *ExecutePolicy
- func (r ExecutePolicy) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *ExecutePolicy) MasterTimeout(duration string) *ExecutePolicy
- func (r ExecutePolicy) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ExecutePolicy) Pretty(pretty bool) *ExecutePolicy
- func (r *ExecutePolicy) WaitForCompletion(waitforcompletion bool) *ExecutePolicy
- type NewExecutePolicy
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type ExecutePolicy ¶
type ExecutePolicy struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ExecutePolicy
Run an enrich policy. Create the enrich index for an existing enrich policy.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-execute-policy
func (ExecutePolicy) Do ¶
func (r ExecutePolicy) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a executepolicy.Response
func (*ExecutePolicy) ErrorTrace ¶
func (r *ExecutePolicy) ErrorTrace(errortrace bool) *ExecutePolicy
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*ExecutePolicy) FilterPath ¶
func (r *ExecutePolicy) FilterPath(filterpaths ...string) *ExecutePolicy
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*ExecutePolicy) Header ¶
func (r *ExecutePolicy) Header(key, value string) *ExecutePolicy
Header set a key, value pair in the ExecutePolicy headers map.
func (*ExecutePolicy) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*ExecutePolicy) Human ¶
func (r *ExecutePolicy) Human(human bool) *ExecutePolicy
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 (ExecutePolicy) IsSuccess ¶
func (r ExecutePolicy) 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 (*ExecutePolicy) MasterTimeout ¶
func (r *ExecutePolicy) MasterTimeout(duration string) *ExecutePolicy
MasterTimeout Period to wait for a connection to the master node. API name: master_timeout
func (ExecutePolicy) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ExecutePolicy) Pretty ¶
func (r *ExecutePolicy) Pretty(pretty bool) *ExecutePolicy
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*ExecutePolicy) WaitForCompletion ¶
func (r *ExecutePolicy) WaitForCompletion(waitforcompletion bool) *ExecutePolicy
WaitForCompletion If `true`, the request blocks other enrich policy execution requests until complete. API name: wait_for_completion
type NewExecutePolicy ¶
type NewExecutePolicy func(name string) *ExecutePolicy
NewExecutePolicy type alias for index.
func NewExecutePolicyFunc ¶
func NewExecutePolicyFunc(tp elastictransport.Interface) NewExecutePolicy
NewExecutePolicyFunc returns a new instance of ExecutePolicy with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files