modifydatastream

package
v9.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 17, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Update data streams. Performs one or more data stream modification actions in a single atomic operation.

Index

Constants

This section is empty.

Variables

View Source
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 ModifyDataStream

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

func New

Update data streams. Performs one or more data stream modification actions in a single atomic operation.

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-modify-data-stream

func (*ModifyDataStream) Actions

Actions to perform. API name: actions

func (ModifyDataStream) Do

func (r ModifyDataStream) Do(providedCtx context.Context) (*Response, error)

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

func (*ModifyDataStream) ErrorTrace

func (r *ModifyDataStream) ErrorTrace(errortrace bool) *ModifyDataStream

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

func (*ModifyDataStream) FilterPath

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

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

func (*ModifyDataStream) Header

func (r *ModifyDataStream) Header(key, value string) *ModifyDataStream

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

func (*ModifyDataStream) HttpRequest

func (r *ModifyDataStream) HttpRequest(ctx context.Context) (*http.Request, error)

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

func (*ModifyDataStream) Human

func (r *ModifyDataStream) Human(human bool) *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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (ModifyDataStream) Perform

func (r ModifyDataStream) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*ModifyDataStream) Pretty

func (r *ModifyDataStream) Pretty(pretty bool) *ModifyDataStream

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

func (*ModifyDataStream) Raw

Raw takes a json payload as input which is then passed to the http.Request If 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.

type NewModifyDataStream

type NewModifyDataStream func() *ModifyDataStream

NewModifyDataStream type alias for index.

func NewModifyDataStreamFunc

func NewModifyDataStreamFunc(tp elastictransport.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.

type Request

type Request struct {

	// Actions Actions to perform.
	Actions []types.IndicesModifyAction `json:"actions"`
}

Request holds the request body struct for the package modifydatastream

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L45

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {

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

Response holds the response body struct for the package modifydatastream

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/indices/modify_data_stream/IndicesModifyDataStreamResponse.ts#L22-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

close