The highest tagged major version is
Documentation
¶
Overview ¶
Create or update a script or search template. Creates or updates a stored script or search template.
Index ¶
- Variables
- type NewPutScript
- type PutScript
- func (r *PutScript) Context(context string) *PutScript
- func (r PutScript) Do(providedCtx context.Context) (*Response, error)
- func (r *PutScript) ErrorTrace(errortrace bool) *PutScript
- func (r *PutScript) FilterPath(filterpaths ...string) *PutScript
- func (r *PutScript) Header(key, value string) *PutScript
- func (r *PutScript) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PutScript) Human(human bool) *PutScript
- func (r *PutScript) MasterTimeout(duration string) *PutScript
- func (r PutScript) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PutScript) Pretty(pretty bool) *PutScript
- func (r *PutScript) Raw(raw io.Reader) *PutScript
- func (r *PutScript) Request(req *Request) *PutScript
- func (r *PutScript) Script(script *types.StoredScript) *PutScript
- func (r *PutScript) Timeout(duration string) *PutScript
- type Request
- 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 NewPutScript ¶
NewPutScript type alias for index.
func NewPutScriptFunc ¶
func NewPutScriptFunc(tp elastictransport.Interface) NewPutScript
NewPutScriptFunc returns a new instance of PutScript with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PutScript ¶
type PutScript struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PutScript
Create or update a script or search template. Creates or updates a stored script or search template.
https://www.elastic.co/guide/en/elasticsearch/reference/current/create-stored-script-api.html
func (*PutScript) Context ¶
Context The context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context. API Name: context
func (PutScript) Do ¶
Do runs the request through the transport, handle the response and returns a putscript.Response
func (*PutScript) ErrorTrace ¶ added in v8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*PutScript) FilterPath ¶ added in v8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*PutScript) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutScript) Human ¶ added in v8.14.0
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 (*PutScript) MasterTimeout ¶
MasterTimeout The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. API name: master_timeout
func (PutScript) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PutScript) Pretty ¶ added in v8.14.0
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*PutScript) Raw ¶
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*PutScript) Request ¶
Request allows to set the request property with the appropriate payload.
func (*PutScript) Script ¶ added in v8.9.0
func (r *PutScript) Script(script *types.StoredScript) *PutScript
Script The script or search template, its parameters, and its language. API name: script
type Request ¶
type Request struct {
// Script The script or search template, its parameters, and its language.
Script types.StoredScript `json:"script"`
}
Request holds the request body struct for the package putscript
Source Files