deletedatastream

Documentation

Overview

Delete data streams. Deletes one or more data streams and their backing indices.

Index

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

Delete data streams. Deletes one or more data streams and their backing indices.

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

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

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

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

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

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

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

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

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

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

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 (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.

func (*DeleteDataStream) Pretty

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

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

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/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/delete_data_stream/IndicesDeleteDataStreamResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response