modifydatastream

Documentation

Overview

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

Index

• Variables
• type ModifyDataStream
  • func New(tp elastictransport.Interface) *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
  • func NewModifyDataStreamFunc(tp elastictransport.Interface) NewModifyDataStream
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response

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.

Types

type ModifyDataStream

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

func New

func New(tp elastictransport.Interface) *ModifyDataStream

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

https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html

func (*ModifyDataStream) Actions

func (r *ModifyDataStream) Actions(actions ...types.IndicesModifyAction) *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

func (r *ModifyDataStream) Raw(raw io.Reader) *ModifyDataStream

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/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L38

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/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/indices/modify_data_stream/IndicesModifyDataStreamResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response