deleteautofollowpattern

Documentation

Overview

Delete auto-follow patterns. Delete a collection of cross-cluster replication auto-follow patterns.

Index

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

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

func New

func New(tp elastictransport.Interface) *DeleteAutoFollowPattern

Delete auto-follow patterns. Delete a collection of cross-cluster replication auto-follow patterns.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html

func (DeleteAutoFollowPattern) Do

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

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

func (*DeleteAutoFollowPattern) ErrorTrace

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

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

func (*DeleteAutoFollowPattern) FilterPath

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

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

func (*DeleteAutoFollowPattern) Header

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

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

func (*DeleteAutoFollowPattern) HttpRequest

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

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

func (*DeleteAutoFollowPattern) Human

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

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

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

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

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

func (*DeleteAutoFollowPattern) Pretty

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

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

type NewDeleteAutoFollowPattern

type NewDeleteAutoFollowPattern func(name string) *DeleteAutoFollowPattern

NewDeleteAutoFollowPattern type alias for index.

func NewDeleteAutoFollowPatternFunc

func NewDeleteAutoFollowPatternFunc(tp elastictransport.Interface) NewDeleteAutoFollowPattern

NewDeleteAutoFollowPatternFunc returns a new instance of DeleteAutoFollowPattern 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 deleteautofollowpattern

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response