getautofollowpattern

Documentation

Overview

Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetAutoFollowPattern

Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.

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

func (GetAutoFollowPattern) Do

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

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

func (*GetAutoFollowPattern) ErrorTrace

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

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

func (*GetAutoFollowPattern) FilterPath

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

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

func (*GetAutoFollowPattern) Header

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

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

func (*GetAutoFollowPattern) HttpRequest

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

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

func (*GetAutoFollowPattern) Human

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

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

func (r GetAutoFollowPattern) 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 (*GetAutoFollowPattern) Name

func (r *GetAutoFollowPattern) Name(name string) *GetAutoFollowPattern

Name Specifies the auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections. API Name: name

func (GetAutoFollowPattern) Perform

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

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

func (*GetAutoFollowPattern) Pretty

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

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

type NewGetAutoFollowPattern

type NewGetAutoFollowPattern func() *GetAutoFollowPattern

NewGetAutoFollowPattern type alias for index.

func NewGetAutoFollowPatternFunc

func NewGetAutoFollowPatternFunc(tp elastictransport.Interface) NewGetAutoFollowPattern

NewGetAutoFollowPatternFunc returns a new instance of GetAutoFollowPattern 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 {
	Patterns []types.AutoFollowPattern `json:"patterns"`
}

Response holds the response body struct for the package getautofollowpattern

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ccr/get_auto_follow_pattern/GetAutoFollowPatternResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response