type Get struct {// contains filtered or unexported fields}

funcNew¶

func New(tpelastictransport.Interface) *Get

Get task information.Get information about a task currently running in the cluster.

WARNING: The task management API is new and should still be considered a betafeature.The API may change in ways that are not backwards compatible.

If the task identifier is not found, a 404 response code indicates that thereare no resources that match the request.

https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html

func (Get)Do¶

func (rGet) Do(providedCtxcontext.Context) (*Response,error)

Do runs the request through the transport, handle the response and returns a get.Response

func (*Get)ErrorTrace¶added inv8.14.0

func (r *Get) ErrorTrace(errortracebool) *Get

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace

func (*Get)FilterPath¶added inv8.14.0

func (r *Get) FilterPath(filterpaths ...string) *Get

FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path

func (*Get)Header¶

func (r *Get) Header(key, valuestring) *Get

Header set a key, value pair in the Get headers map.

func (*Get)HttpRequest¶

func (r *Get) HttpRequest(ctxcontext.Context) (*http.Request,error)

HttpRequest returns the http.Request object built from thegiven parameters.

func (*Get)Human¶added inv8.14.0

func (r *Get) Human(humanbool) *Get

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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human

func (Get)IsSuccess¶

func (rGet) IsSuccess(providedCtxcontext.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 (Get)Perform¶added inv8.7.0

func (rGet) Perform(providedCtxcontext.Context) (*http.Response,error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*Get)Pretty¶added inv8.14.0

func (r *Get) Pretty(prettybool) *Get

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty

func (*Get)Timeout¶

func (r *Get) Timeout(durationstring) *Get

Timeout The period to wait for a response.If no response is received before the timeout expires, the request fails andreturns an error.API name: timeout

func (*Get)WaitForCompletion¶

func (r *Get) WaitForCompletion(waitforcompletionbool) *Get

WaitForCompletion If `true`, the request blocks until the task has completed.API name: wait_for_completion

type NewGet func(taskidstring) *Get

funcNewGetFunc¶

func NewGetFunc(tpelastictransport.Interface)NewGet

NewGetFunc returns a new instance of Get with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.

type Response struct {Completedbool              `json:"completed"`Error     *types.ErrorCause `json:"error,omitempty"`Responsejson.RawMessage   `json:"response,omitempty"`Tasktypes.TaskInfo    `json:"task"`}

funcNewResponse¶added inv8.7.0

func NewResponse() *Response

NewResponse returns a Response