The highest tagged major version is
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) ErrorTrace(errortrace bool) *ResumeAutoFollowPattern
- func (r *ResumeAutoFollowPattern) FilterPath(filterpaths ...string) *ResumeAutoFollowPattern
- func (r *ResumeAutoFollowPattern) Header(key, value string) *ResumeAutoFollowPattern
- func (r *ResumeAutoFollowPattern) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *ResumeAutoFollowPattern) Human(human bool) *ResumeAutoFollowPattern
- func (r ResumeAutoFollowPattern) IsSuccess(providedCtx context.Context) (bool, error)
- func (r ResumeAutoFollowPattern) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ResumeAutoFollowPattern) Pretty(pretty bool) *ResumeAutoFollowPattern
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) ErrorTrace ¶ added in v8.14.0
func (r *ResumeAutoFollowPattern) ErrorTrace(errortrace bool) *ResumeAutoFollowPattern
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*ResumeAutoFollowPattern) FilterPath ¶ added in v8.14.0
func (r *ResumeAutoFollowPattern) FilterPath(filterpaths ...string) *ResumeAutoFollowPattern
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
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) Human ¶ added in v8.14.0
func (r *ResumeAutoFollowPattern) Human(human bool) *ResumeAutoFollowPattern
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 (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.
func (ResumeAutoFollowPattern) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ResumeAutoFollowPattern) Pretty ¶ added in v8.14.0
func (r *ResumeAutoFollowPattern) Pretty(pretty bool) *ResumeAutoFollowPattern
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
Source Files