Documentation
¶
Overview ¶
Get a script or search template. Retrieves a stored script or search template.
Index ¶
- Variables
- type GetScript
- func (r GetScript) Do(providedCtx context.Context) (*Response, error)
- func (r *GetScript) ErrorTrace(errortrace bool) *GetScript
- func (r *GetScript) FilterPath(filterpaths ...string) *GetScript
- func (r *GetScript) Header(key, value string) *GetScript
- func (r *GetScript) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetScript) Human(human bool) *GetScript
- func (r GetScript) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetScript) MasterTimeout(duration string) *GetScript
- func (r GetScript) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetScript) Pretty(pretty bool) *GetScript
- type NewGetScript
- 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 GetScript ¶
type GetScript struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetScript
Get a script or search template. Retrieves a stored script or search template.
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script
func (GetScript) Do ¶
Do runs the request through the transport, handle the response and returns a getscript.Response
func (*GetScript) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*GetScript) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*GetScript) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetScript) Human ¶
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (GetScript) IsSuccess ¶
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 (*GetScript) MasterTimeout ¶
MasterTimeout The period to wait for the master node. If the master node is not available 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
type NewGetScript ¶
NewGetScript type alias for index.
func NewGetScriptFunc ¶
func NewGetScriptFunc(tp elastictransport.Interface) NewGetScript
NewGetScriptFunc returns a new instance of GetScript with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files