modifydatastream

Documentation

Overview

Modifies a data stream

Index

• Variables
• type ModifyDataStream
  • func New(tp elastictransport.Interface) *ModifyDataStream
  • func (r *ModifyDataStream) Actions(actions ...types.IndicesModifyAction) *ModifyDataStream
  • func (r ModifyDataStream) Do(ctx context.Context) (*Response, error)
  • func (r *ModifyDataStream) Header(key, value string) *ModifyDataStream
  • func (r *ModifyDataStream) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r ModifyDataStream) Perform(ctx context.Context) (*http.Response, error)
  • 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

Modifies a data stream

https://www.elastic.co/guide/en/elasticsearch/reference/master/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(ctx context.Context) (*Response, error)

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

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

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

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

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/ac9c431ec04149d9048f2b8f9731e3c2f7f38754/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L36

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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response