deletedatastream

Documentation

Overview

Deletes a data stream.

Index

• Variables
• type DeleteDataStream
  • func New(tp elastictransport.Interface) *DeleteDataStream
  • func (r DeleteDataStream) Do(providedCtx context.Context) (*Response, error)
  • func (r *DeleteDataStream) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *DeleteDataStream
  • func (r *DeleteDataStream) Header(key, value string) *DeleteDataStream
  • func (r *DeleteDataStream) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeleteDataStream) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r DeleteDataStream) Perform(providedCtx context.Context) (*http.Response, error)
• type NewDeleteDataStream
  • func NewDeleteDataStreamFunc(tp elastictransport.Interface) NewDeleteDataStream
• 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 DeleteDataStream

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

func New

func New(tp elastictransport.Interface) *DeleteDataStream

Deletes a data stream.

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

func (DeleteDataStream) Do

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

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

func (*DeleteDataStream) ExpandWildcards

func (r *DeleteDataStream) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *DeleteDataStream

ExpandWildcards Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`. API name: expand_wildcards

func (*DeleteDataStream) Header

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

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

func (*DeleteDataStream) HttpRequest

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

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

func (DeleteDataStream) IsSuccess

func (r DeleteDataStream) 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 (DeleteDataStream) Perform

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

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

type NewDeleteDataStream

type NewDeleteDataStream func(name string) *DeleteDataStream

NewDeleteDataStream type alias for index.

func NewDeleteDataStreamFunc

func NewDeleteDataStreamFunc(tp elastictransport.Interface) NewDeleteDataStream

NewDeleteDataStreamFunc returns a new instance of DeleteDataStream 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 deletedatastream

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/indices/delete_data_stream/IndicesDeleteDataStreamResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response