Documentation
¶
Overview ¶
Resumes an auto-follow pattern that has been paused
Index ¶
- Variables
- type NewResumeAutoFollowPattern
- type Response
- type ResumeAutoFollowPattern
- func (r ResumeAutoFollowPattern) Do(providedCtx context.Context) (*Response, error)
- func (r *ResumeAutoFollowPattern) Header(key, value string) *ResumeAutoFollowPattern
- func (r *ResumeAutoFollowPattern) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r ResumeAutoFollowPattern) IsSuccess(providedCtx context.Context) (bool, error)
- func (r ResumeAutoFollowPattern) Perform(providedCtx context.Context) (*http.Response, error)
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 NewResumeAutoFollowPattern ¶
type NewResumeAutoFollowPattern func(name string) *ResumeAutoFollowPattern
NewResumeAutoFollowPattern type alias for index.
func NewResumeAutoFollowPatternFunc ¶
func NewResumeAutoFollowPatternFunc(tp elastictransport.Interface) NewResumeAutoFollowPattern
NewResumeAutoFollowPatternFunc returns a new instance of ResumeAutoFollowPattern with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶ added in v8.7.0
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 resumeautofollowpattern
type ResumeAutoFollowPattern ¶
type ResumeAutoFollowPattern struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ResumeAutoFollowPattern
Resumes an auto-follow pattern that has been paused
https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-resume-auto-follow-pattern.html
func (ResumeAutoFollowPattern) Do ¶
func (r ResumeAutoFollowPattern) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a resumeautofollowpattern.Response
func (*ResumeAutoFollowPattern) Header ¶
func (r *ResumeAutoFollowPattern) Header(key, value string) *ResumeAutoFollowPattern
Header set a key, value pair in the ResumeAutoFollowPattern headers map.
func (*ResumeAutoFollowPattern) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (ResumeAutoFollowPattern) IsSuccess ¶
func (r ResumeAutoFollowPattern) 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