updateerror
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Update the connector error field.
Set the error field for the connector.If the error provided in the request body is non-null, the connector’s statusis updated to error.Otherwise, if the error is reset to null, the connector status is updated toconnected.
Index¶
- Variables
- type NewUpdateError
- type Request
- type Response
- type UpdateError
- func (r UpdateError) Do(providedCtx context.Context) (*Response, error)
- func (r *UpdateError) Error(error any) *UpdateError
- func (r *UpdateError) ErrorTrace(errortrace bool) *UpdateError
- func (r *UpdateError) FilterPath(filterpaths ...string) *UpdateError
- func (r *UpdateError) Header(key, value string) *UpdateError
- func (r *UpdateError) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *UpdateError) Human(human bool) *UpdateError
- func (r UpdateError) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *UpdateError) Pretty(pretty bool) *UpdateError
- func (r *UpdateError) Raw(raw io.Reader) *UpdateError
- func (r *UpdateError) Request(req *Request) *UpdateError
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¶
typeNewUpdateError¶
type NewUpdateError func(connectoridstring) *UpdateError
NewUpdateError type alias for index.
funcNewUpdateErrorFunc¶
func NewUpdateErrorFunc(tpelastictransport.Interface)NewUpdateError
NewUpdateErrorFunc returns a new instance of UpdateError with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.
typeRequest¶
type Request struct {Errorany `json:"error"`}Request holds the request body struct for the package updateerror
func (*Request)UnmarshalJSON¶
typeUpdateError¶
type UpdateError struct {// contains filtered or unexported fields}funcNew¶
func New(tpelastictransport.Interface) *UpdateError
Update the connector error field.
Set the error field for the connector.If the error provided in the request body is non-null, the connector’s statusis updated to error.Otherwise, if the error is reset to null, the connector status is updated toconnected.
https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-error-api.html
func (UpdateError)Do¶
func (rUpdateError) Do(providedCtxcontext.Context) (*Response,error)
Do runs the request through the transport, handle the response and returns a updateerror.Response
func (*UpdateError)ErrorTrace¶
func (r *UpdateError) ErrorTrace(errortracebool) *UpdateError
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace
func (*UpdateError)FilterPath¶
func (r *UpdateError) FilterPath(filterpaths ...string) *UpdateError
FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path
func (*UpdateError)Header¶
func (r *UpdateError) Header(key, valuestring) *UpdateError
Header set a key, value pair in the UpdateError headers map.
func (*UpdateError)HttpRequest¶
HttpRequest returns the http.Request object built from thegiven parameters.
func (*UpdateError)Human¶
func (r *UpdateError) Human(humanbool) *UpdateError
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 (UpdateError)Perform¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*UpdateError)Pretty¶
func (r *UpdateError) Pretty(prettybool) *UpdateError
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty
func (*UpdateError)Raw¶
func (r *UpdateError) Raw(rawio.Reader) *UpdateError
Raw takes a json payload as input which is then passed to the http.RequestIf specified Raw takes precedence on Request method.
func (*UpdateError)Request¶
func (r *UpdateError) Request(req *Request) *UpdateError
Request allows to set the request property with the appropriate payload.