Documentation ¶
Overview ¶
Retrieves a watch by its ID.
Index ¶
- Variables
- type GetWatch
- func (r GetWatch) Do(ctx context.Context) (*Response, error)
- func (r *GetWatch) Header(key, value string) *GetWatch
- func (r *GetWatch) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetWatch) IsSuccess(ctx context.Context) (bool, error)
- func (r GetWatch) Perform(ctx context.Context) (*http.Response, error)
- type NewGetWatch
- 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 GetWatch ¶
type GetWatch struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetWatch
Retrieves a watch by its ID.
https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html
func (GetWatch) Do ¶
Do runs the request through the transport, handle the response and returns a getwatch.Response
func (*GetWatch) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
type NewGetWatch ¶
NewGetWatch type alias for index.
func NewGetWatchFunc ¶
func NewGetWatchFunc(tp elastictransport.Interface) NewGetWatch
NewGetWatchFunc returns a new instance of GetWatch 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 { Found bool `json:"found"` Id_ string `json:"_id"` PrimaryTerm_ *int `json:"_primary_term,omitempty"` SeqNo_ *int64 `json:"_seq_no,omitempty"` Status *types.WatchStatus `json:"status,omitempty"` Version_ *int64 `json:"_version,omitempty"` Watch *types.Watch `json:"watch,omitempty"` }
Response holds the response body struct for the package getwatch