deletepipeline

Documentation

Overview

Deletes a pipeline used for Logstash Central Management.

Index

• Variables
• type DeletePipeline
  • func New(tp elastictransport.Interface) *DeletePipeline
  • func (r DeletePipeline) Do(ctx context.Context) (bool, error)
  • func (r *DeletePipeline) ErrorTrace(errortrace bool) *DeletePipeline
  • func (r *DeletePipeline) FilterPath(filterpaths ...string) *DeletePipeline
  • func (r *DeletePipeline) Header(key, value string) *DeletePipeline
  • func (r *DeletePipeline) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *DeletePipeline) Human(human bool) *DeletePipeline
  • func (r DeletePipeline) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r DeletePipeline) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *DeletePipeline) Pretty(pretty bool) *DeletePipeline
• type NewDeletePipeline
  • func NewDeletePipelineFunc(tp elastictransport.Interface) NewDeletePipeline

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 DeletePipeline

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

func New

func New(tp elastictransport.Interface) *DeletePipeline

Deletes a pipeline used for Logstash Central Management.

https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html

func (DeletePipeline) Do

func (r DeletePipeline) Do(ctx context.Context) (bool, error)

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

func (*DeletePipeline) ErrorTrace

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

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

func (*DeletePipeline) FilterPath

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

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

func (*DeletePipeline) Header

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

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

func (*DeletePipeline) HttpRequest

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

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

func (*DeletePipeline) Human

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

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 (DeletePipeline) IsSuccess

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

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

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

func (*DeletePipeline) Pretty

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

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

type NewDeletePipeline

type NewDeletePipeline func(id string) *DeletePipeline

NewDeletePipeline type alias for index.

func NewDeletePipelineFunc

func NewDeletePipelineFunc(tp elastictransport.Interface) NewDeletePipeline

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