deletepipeline

Documentation

Overview

Deletes a pipeline.

Index

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

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

func New

func New(tp elastictransport.Interface) *DeletePipeline

Deletes a pipeline.

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

func (DeletePipeline) Do

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

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

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

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

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

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

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

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

func (*DeletePipeline) Timeout

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

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

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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response