Documentation
¶
Overview ¶
Allows an arbitrary script to be executed and a result to be returned
Index ¶
- Variables
- type NewScriptsPainlessExecute
- type Request
- type Response
- type ScriptsPainlessExecute
- func (r *ScriptsPainlessExecute) Context(context string) *ScriptsPainlessExecute
- func (r *ScriptsPainlessExecute) ContextSetup(contextsetup *types.PainlessContextSetup) *ScriptsPainlessExecute
- func (r ScriptsPainlessExecute) Do(providedCtx context.Context) (*Response, error)
- func (r *ScriptsPainlessExecute) Header(key, value string) *ScriptsPainlessExecute
- func (r *ScriptsPainlessExecute) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r ScriptsPainlessExecute) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ScriptsPainlessExecute) Raw(raw io.Reader) *ScriptsPainlessExecute
- func (r *ScriptsPainlessExecute) Request(req *Request) *ScriptsPainlessExecute
- func (r *ScriptsPainlessExecute) Script(script *types.InlineScript) *ScriptsPainlessExecute
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 NewScriptsPainlessExecute ¶
type NewScriptsPainlessExecute func() *ScriptsPainlessExecute
NewScriptsPainlessExecute type alias for index.
func NewScriptsPainlessExecuteFunc ¶
func NewScriptsPainlessExecuteFunc(tp elastictransport.Interface) NewScriptsPainlessExecute
NewScriptsPainlessExecuteFunc returns a new instance of ScriptsPainlessExecute with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Request ¶
type Request struct {
// Context The context that the script should run in.
Context *string `json:"context,omitempty"`
// ContextSetup Additional parameters for the `context`.
ContextSetup *types.PainlessContextSetup `json:"context_setup,omitempty"`
// Script The Painless script to execute.
Script *types.InlineScript `json:"script,omitempty"`
}
Request holds the request body struct for the package scriptspainlessexecute
type Response ¶ added in v8.7.0
type Response struct {
Result json.RawMessage `json:"result,omitempty"`
}
Response holds the response body struct for the package scriptspainlessexecute
type ScriptsPainlessExecute ¶
type ScriptsPainlessExecute struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ScriptsPainlessExecute
Allows an arbitrary script to be executed and a result to be returned
https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html
func (*ScriptsPainlessExecute) Context ¶ added in v8.9.0
func (r *ScriptsPainlessExecute) Context(context string) *ScriptsPainlessExecute
Context The context that the script should run in. API name: context
func (*ScriptsPainlessExecute) ContextSetup ¶ added in v8.9.0
func (r *ScriptsPainlessExecute) ContextSetup(contextsetup *types.PainlessContextSetup) *ScriptsPainlessExecute
ContextSetup Additional parameters for the `context`. API name: context_setup
func (ScriptsPainlessExecute) Do ¶
func (r ScriptsPainlessExecute) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a scriptspainlessexecute.Response
func (*ScriptsPainlessExecute) Header ¶
func (r *ScriptsPainlessExecute) Header(key, value string) *ScriptsPainlessExecute
Header set a key, value pair in the ScriptsPainlessExecute headers map.
func (*ScriptsPainlessExecute) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (ScriptsPainlessExecute) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ScriptsPainlessExecute) Raw ¶
func (r *ScriptsPainlessExecute) Raw(raw io.Reader) *ScriptsPainlessExecute
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*ScriptsPainlessExecute) Request ¶
func (r *ScriptsPainlessExecute) Request(req *Request) *ScriptsPainlessExecute
Request allows to set the request property with the appropriate payload.
func (*ScriptsPainlessExecute) Script ¶ added in v8.9.0
func (r *ScriptsPainlessExecute) Script(script *types.InlineScript) *ScriptsPainlessExecute
Script The Painless script to execute. API name: script
Source Files