type NewStopTransform func(transformidstring) *StopTransform

funcNewStopTransformFunc¶

func NewStopTransformFunc(tpelastictransport.Interface)NewStopTransform

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

type Response struct {// Acknowledged For a successful response, this value is always true. On failure, an// exception is returned instead.Acknowledgedbool `json:"acknowledged"`}

funcNewResponse¶added inv8.7.0

func NewResponse() *Response

NewResponse returns a Response

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

funcNew¶

func New(tpelastictransport.Interface) *StopTransform

Stop transforms.Stops one or more transforms.

https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html

func (*StopTransform)AllowNoMatch¶

func (r *StopTransform) AllowNoMatch(allownomatchbool) *StopTransform

AllowNoMatch Specifies what to do when the request: contains wildcard expressions andthere are no transforms that match;contains the `_all` string or no identifiers and there are no matches;contains wildcard expressions and thereare only partial matches.

If it is true, the API returns a successful acknowledgement message whenthere are no matches. When there areonly partial matches, the API stops the appropriate transforms.

If it is false, the request returns a 404 status code when there are nomatches or only partial matches.API name: allow_no_match

func (StopTransform)Do¶

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

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

func (*StopTransform)ErrorTrace¶added inv8.14.0

func (r *StopTransform) ErrorTrace(errortracebool) *StopTransform

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

func (*StopTransform)FilterPath¶added inv8.14.0

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

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

func (*StopTransform)Force¶

func (r *StopTransform) Force(forcebool) *StopTransform

Force If it is true, the API forcefully stops the transforms.API name: force

func (*StopTransform)Header¶

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

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

func (*StopTransform)HttpRequest¶

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

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

func (*StopTransform)Human¶added inv8.14.0

func (r *StopTransform) Human(humanbool) *StopTransform

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 (StopTransform)IsSuccess¶

func (rStopTransform) 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 (StopTransform)Perform¶added inv8.7.0

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

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

func (*StopTransform)Pretty¶added inv8.14.0

func (r *StopTransform) Pretty(prettybool) *StopTransform

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

func (*StopTransform)Timeout¶

func (r *StopTransform) Timeout(durationstring) *StopTransform

Timeout Period to wait for a response when `wait_for_completion` is `true`. If noresponse is received before thetimeout expires, the request returns a timeout exception. However, therequest continues processing andeventually moves the transform to a STOPPED state.API name: timeout

func (*StopTransform)WaitForCheckpoint¶

func (r *StopTransform) WaitForCheckpoint(waitforcheckpointbool) *StopTransform

WaitForCheckpoint If it is true, the transform does not completely stop until the currentcheckpoint is completed. If it is false,the transform stops as soon as possible.API name: wait_for_checkpoint

func (*StopTransform)WaitForCompletion¶

func (r *StopTransform) WaitForCompletion(waitforcompletionbool) *StopTransform

WaitForCompletion If it is true, the API blocks until the indexer state completely stops. If itis false, the API returnsimmediately and the indexer is stopped asynchronously in the background.API name: wait_for_completion