The highest tagged major version is
Documentation
¶
Overview ¶
Get script contexts.
Get a list of supported script contexts and their methods.
Index ¶
- Variables
- type GetScriptContext
- func (r GetScriptContext) Do(providedCtx context.Context) (*Response, error)
- func (r *GetScriptContext) ErrorTrace(errortrace bool) *GetScriptContext
- func (r *GetScriptContext) FilterPath(filterpaths ...string) *GetScriptContext
- func (r *GetScriptContext) Header(key, value string) *GetScriptContext
- func (r *GetScriptContext) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetScriptContext) Human(human bool) *GetScriptContext
- func (r GetScriptContext) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetScriptContext) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetScriptContext) Pretty(pretty bool) *GetScriptContext
- type NewGetScriptContext
- 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 GetScriptContext ¶
type GetScriptContext struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetScriptContext
Get script contexts.
Get a list of supported script contexts and their methods.
https://www.elastic.co/guide/en/elasticsearch/reference/current/get-script-contexts-api.html
func (GetScriptContext) Do ¶
func (r GetScriptContext) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a getscriptcontext.Response
func (*GetScriptContext) ErrorTrace ¶ added in v8.14.0
func (r *GetScriptContext) ErrorTrace(errortrace bool) *GetScriptContext
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*GetScriptContext) FilterPath ¶ added in v8.14.0
func (r *GetScriptContext) FilterPath(filterpaths ...string) *GetScriptContext
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*GetScriptContext) Header ¶
func (r *GetScriptContext) Header(key, value string) *GetScriptContext
Header set a key, value pair in the GetScriptContext headers map.
func (*GetScriptContext) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetScriptContext) Human ¶ added in v8.14.0
func (r *GetScriptContext) Human(human bool) *GetScriptContext
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 (GetScriptContext) IsSuccess ¶
func (r GetScriptContext) 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 (GetScriptContext) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetScriptContext) Pretty ¶ added in v8.14.0
func (r *GetScriptContext) Pretty(pretty bool) *GetScriptContext
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
type NewGetScriptContext ¶
type NewGetScriptContext func() *GetScriptContext
NewGetScriptContext type alias for index.
func NewGetScriptContextFunc ¶
func NewGetScriptContextFunc(tp elastictransport.Interface) NewGetScriptContext
NewGetScriptContextFunc returns a new instance of GetScriptContext with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶ added in v8.7.0
type Response struct {
Contexts []types.GetScriptContext `json:"contexts"`
}
Response holds the response body struct for the package getscriptcontext
Source Files