createdatastream

Documentation

Overview

Create a data stream.

You must have a matching index template with data stream enabled.

Index

• Variables
• type CreateDataStream
  • func New(tp elastictransport.Interface) *CreateDataStream
  • func (r CreateDataStream) Do(providedCtx context.Context) (*Response, error)
  • func (r *CreateDataStream) ErrorTrace(errortrace bool) *CreateDataStream
  • func (r *CreateDataStream) FilterPath(filterpaths ...string) *CreateDataStream
  • func (r *CreateDataStream) Header(key, value string) *CreateDataStream
  • func (r *CreateDataStream) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *CreateDataStream) Human(human bool) *CreateDataStream
  • func (r CreateDataStream) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *CreateDataStream) MasterTimeout(duration string) *CreateDataStream
  • func (r CreateDataStream) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *CreateDataStream) Pretty(pretty bool) *CreateDataStream
  • func (r *CreateDataStream) Timeout(duration string) *CreateDataStream
• 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

Create a data stream.

You must have a matching index template with data stream enabled.

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

func (CreateDataStream) Do

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

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

func (*CreateDataStream) ErrorTrace

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

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

func (*CreateDataStream) FilterPath

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

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

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

func (r *CreateDataStream) Human(human bool) *CreateDataStream

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (CreateDataStream) IsSuccess

func (r CreateDataStream) IsSuccess(providedCtx 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) MasterTimeout

func (r *CreateDataStream) MasterTimeout(duration string) *CreateDataStream

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (CreateDataStream) Perform

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

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

func (*CreateDataStream) Pretty

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

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

func (*CreateDataStream) Timeout

func (r *CreateDataStream) Timeout(duration string) *CreateDataStream

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

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/907d11a72a6bfd37b777d526880c56202889609e/specification/indices/create_data_stream/IndicesCreateDataStreamResponse.ts#L22-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response