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(ctx context.Context) (*Response, error)
  • func (r *GetAutoFollowPattern) Header(key, value string) *GetAutoFollowPattern
  • func (r *GetAutoFollowPattern) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r GetAutoFollowPattern) IsSuccess(ctx context.Context) (bool, error)
  • func (r *GetAutoFollowPattern) Name(v string) *GetAutoFollowPattern
  • func (r GetAutoFollowPattern) Perform(ctx context.Context) (*http.Response, error)
• 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/{branch}/ccr-get-auto-follow-pattern.html

func (GetAutoFollowPattern) Do

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

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

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

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

func (r *GetAutoFollowPattern) Name(v 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(ctx context.Context) (*http.Response, error)

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

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response