modifydatastream
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 data streams.Performs one or more data stream modification actions in a single atomicoperation.
Index¶
- Variables
- type ModifyDataStream
- func (r *ModifyDataStream) Actions(actions ...types.IndicesModifyAction) *ModifyDataStream
- func (r ModifyDataStream) Do(providedCtx context.Context) (*Response, error)
- func (r *ModifyDataStream) ErrorTrace(errortrace bool) *ModifyDataStream
- func (r *ModifyDataStream) FilterPath(filterpaths ...string) *ModifyDataStream
- func (r *ModifyDataStream) Header(key, value string) *ModifyDataStream
- func (r *ModifyDataStream) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *ModifyDataStream) Human(human bool) *ModifyDataStream
- func (r ModifyDataStream) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ModifyDataStream) Pretty(pretty bool) *ModifyDataStream
- func (r *ModifyDataStream) Raw(raw io.Reader) *ModifyDataStream
- func (r *ModifyDataStream) Request(req *Request) *ModifyDataStream
- type NewModifyDataStream
- type Request
- 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¶
typeModifyDataStream¶
type ModifyDataStream struct {// contains filtered or unexported fields}funcNew¶
func New(tpelastictransport.Interface) *ModifyDataStream
Update data streams.Performs one or more data stream modification actions in a single atomicoperation.
https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-modify-data-stream
func (*ModifyDataStream)Actions¶added inv8.9.0
func (r *ModifyDataStream) Actions(actions ...types.IndicesModifyAction) *ModifyDataStream
Actions Actions to perform.API name: actions
func (ModifyDataStream)Do¶
func (rModifyDataStream) Do(providedCtxcontext.Context) (*Response,error)
Do runs the request through the transport, handle the response and returns a modifydatastream.Response
func (*ModifyDataStream)ErrorTrace¶added inv8.14.0
func (r *ModifyDataStream) ErrorTrace(errortracebool) *ModifyDataStream
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace
func (*ModifyDataStream)FilterPath¶added inv8.14.0
func (r *ModifyDataStream) FilterPath(filterpaths ...string) *ModifyDataStream
FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path
func (*ModifyDataStream)Header¶
func (r *ModifyDataStream) Header(key, valuestring) *ModifyDataStream
Header set a key, value pair in the ModifyDataStream headers map.
func (*ModifyDataStream)HttpRequest¶
HttpRequest returns the http.Request object built from thegiven parameters.
func (*ModifyDataStream)Human¶added inv8.14.0
func (r *ModifyDataStream) Human(humanbool) *ModifyDataStream
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 (ModifyDataStream)Perform¶added inv8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ModifyDataStream)Pretty¶added inv8.14.0
func (r *ModifyDataStream) Pretty(prettybool) *ModifyDataStream
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty
func (*ModifyDataStream)Raw¶
func (r *ModifyDataStream) Raw(rawio.Reader) *ModifyDataStream
Raw takes a json payload as input which is then passed to the http.RequestIf specified Raw takes precedence on Request method.
func (*ModifyDataStream)Request¶
func (r *ModifyDataStream) Request(req *Request) *ModifyDataStream
Request allows to set the request property with the appropriate payload.
typeNewModifyDataStream¶
type NewModifyDataStream func() *ModifyDataStream
NewModifyDataStream type alias for index.
funcNewModifyDataStreamFunc¶
func NewModifyDataStreamFunc(tpelastictransport.Interface)NewModifyDataStream
NewModifyDataStreamFunc returns a new instance of ModifyDataStream with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.
typeRequest¶
type Request struct {// Actions Actions to perform.Actions []types.IndicesModifyAction `json:"actions"`}Request holds the request body struct for the package modifydatastream