createdatastream

Documentation

Overview

Creates a data stream

Index

• Variables
• type CreateDataStream
  • func New(tp elastictransport.Interface) *CreateDataStream
  • func (r CreateDataStream) Do(ctx context.Context) (*Response, error)
  • func (r *CreateDataStream) Header(key, value string) *CreateDataStream
  • func (r *CreateDataStream) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r CreateDataStream) IsSuccess(ctx context.Context) (bool, error)
  • func (r CreateDataStream) Perform(ctx context.Context) (*http.Response, error)
• type NewCreateDataStream
  • func NewCreateDataStreamFunc(tp elastictransport.Interface) NewCreateDataStream
• 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 CreateDataStream

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

func New

func New(tp elastictransport.Interface) *CreateDataStream

Creates a data stream

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

func (CreateDataStream) Do

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

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

func (*CreateDataStream) Header

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

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

func (*CreateDataStream) HttpRequest

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

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

func (CreateDataStream) IsSuccess

func (r CreateDataStream) IsSuccess(ctx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (CreateDataStream) Perform

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

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

type NewCreateDataStream

type NewCreateDataStream func(name string) *CreateDataStream

NewCreateDataStream type alias for index.

func NewCreateDataStreamFunc

func NewCreateDataStreamFunc(tp elastictransport.Interface) NewCreateDataStream

NewCreateDataStreamFunc returns a new instance of CreateDataStream with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

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 createdatastream

https://github.com/elastic/elasticsearch-specification/blob/5fea44e006349579bf3561a82e997002e5716117/specification/indices/create_data_stream/IndicesCreateDataStreamResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response