Documentation
¶
Overview ¶
Retrieve settings for the watcher system index
Index ¶
- Variables
- type GetSettings
- func (r GetSettings) Do(ctx context.Context) (bool, error)
- func (r *GetSettings) Header(key, value string) *GetSettings
- func (r *GetSettings) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetSettings) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetSettings) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGetSettings
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 GetSettings ¶
type GetSettings struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetSettings
Retrieve settings for the watcher system index
https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-settings.html
func (GetSettings) Do ¶ added in v8.9.0
func (r GetSettings) Do(ctx context.Context) (bool, error)
Do runs the request through the transport, handle the response and returns a getsettings.Response
func (*GetSettings) Header ¶
func (r *GetSettings) Header(key, value string) *GetSettings
Header set a key, value pair in the GetSettings headers map.
func (*GetSettings) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
type NewGetSettings ¶
type NewGetSettings func() *GetSettings
NewGetSettings type alias for index.
func NewGetSettingsFunc ¶
func NewGetSettingsFunc(tp elastictransport.Interface) NewGetSettings
NewGetSettingsFunc returns a new instance of GetSettings with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files