modifydatastream

Documentation

Overview

Modifies a data stream

Index

• Variables
• type ModifyDataStream
  • func New(tp elastictransport.Interface) *ModifyDataStream
  • func (r ModifyDataStream) Do(ctx context.Context) (*http.Response, error)
  • func (r *ModifyDataStream) Header(key, value string) *ModifyDataStream
  • func (r *ModifyDataStream) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ModifyDataStream) Raw(raw json.RawMessage) *ModifyDataStream
  • func (r *ModifyDataStream) Request(req *Request) *ModifyDataStream
• type NewModifyDataStream
  • func NewModifyDataStreamFunc(tp elastictransport.Interface) NewModifyDataStream
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Actions(actions []types.ActionBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

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

Modifies a data stream

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

func (ModifyDataStream) Do

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

Do runs the http.Request through the provided transport.

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) Raw

func (r *ModifyDataStream) Raw(raw json.RawMessage) *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.Action `json:"actions"`
}

Request holds the request body struct for the package modifydatastream

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L35

type RequestBuilder

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

RequestBuilder is the builder API for the modifydatastream.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Actions

func (rb *RequestBuilder) Actions(actions []types.ActionBuilder) *RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure