deletepolicy

Documentation

Overview

Deletes an existing enrich policy and its enrich index.

Index

• Variables
• type DeletePolicy
  • func New(tp elastictransport.Interface) *DeletePolicy
  • func (r DeletePolicy) Do(providedCtx context.Context) (*Response, error)
  • func (r *DeletePolicy) Header(key, value string) *DeletePolicy
  • func (r *DeletePolicy) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeletePolicy) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r DeletePolicy) Perform(providedCtx context.Context) (*http.Response, error)
• type NewDeletePolicy
  • func NewDeletePolicyFunc(tp elastictransport.Interface) NewDeletePolicy
• 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 DeletePolicy

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

func New

func New(tp elastictransport.Interface) *DeletePolicy

Deletes an existing enrich policy and its enrich index.

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

func (DeletePolicy) Do

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

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

func (*DeletePolicy) Header

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

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

func (*DeletePolicy) HttpRequest

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

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

func (DeletePolicy) IsSuccess

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

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

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

type NewDeletePolicy

type NewDeletePolicy func(name string) *DeletePolicy

NewDeletePolicy type alias for index.

func NewDeletePolicyFunc

func NewDeletePolicyFunc(tp elastictransport.Interface) NewDeletePolicy

NewDeletePolicyFunc returns a new instance of DeletePolicy 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 deletepolicy

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/enrich/delete_policy/DeleteEnrichPolicyResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response