Documentation
¶
Overview ¶
Pauses an auto-follow pattern
Index ¶
- Variables
- type NewPauseAutoFollowPattern
- type PauseAutoFollowPattern
- func (r PauseAutoFollowPattern) Do(providedCtx context.Context) (*Response, error)
- func (r *PauseAutoFollowPattern) Header(key, value string) *PauseAutoFollowPattern
- func (r *PauseAutoFollowPattern) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r PauseAutoFollowPattern) IsSuccess(providedCtx context.Context) (bool, error)
- func (r PauseAutoFollowPattern) Perform(providedCtx context.Context) (*http.Response, error)
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type NewPauseAutoFollowPattern ¶
type NewPauseAutoFollowPattern func(name string) *PauseAutoFollowPattern
NewPauseAutoFollowPattern type alias for index.
func NewPauseAutoFollowPatternFunc ¶
func NewPauseAutoFollowPatternFunc(tp elastictransport.Interface) NewPauseAutoFollowPattern
NewPauseAutoFollowPatternFunc returns a new instance of PauseAutoFollowPattern with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PauseAutoFollowPattern ¶
type PauseAutoFollowPattern struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PauseAutoFollowPattern
Pauses an auto-follow pattern
https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html
func (PauseAutoFollowPattern) Do ¶
func (r PauseAutoFollowPattern) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a pauseautofollowpattern.Response
func (*PauseAutoFollowPattern) Header ¶
func (r *PauseAutoFollowPattern) Header(key, value string) *PauseAutoFollowPattern
Header set a key, value pair in the PauseAutoFollowPattern headers map.
func (*PauseAutoFollowPattern) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (PauseAutoFollowPattern) IsSuccess ¶
func (r PauseAutoFollowPattern) 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.
Source Files