updatesettings

Documentation

Overview

Update settings for the watcher system index

Index

• Variables
• type NewUpdateSettings
  • func NewUpdateSettingsFunc(tp elastictransport.Interface) NewUpdateSettings
• type UpdateSettings
  • func New(tp elastictransport.Interface) *UpdateSettings
  • func (r UpdateSettings) Do(ctx context.Context) (bool, error)
  • func (r *UpdateSettings) Header(key, value string) *UpdateSettings
  • func (r *UpdateSettings) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r UpdateSettings) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r UpdateSettings) Perform(providedCtx context.Context) (*http.Response, error)

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.

Types

type NewUpdateSettings

type NewUpdateSettings func() *UpdateSettings

NewUpdateSettings type alias for index.

func NewUpdateSettingsFunc

func NewUpdateSettingsFunc(tp elastictransport.Interface) NewUpdateSettings

NewUpdateSettingsFunc returns a new instance of UpdateSettings with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type UpdateSettings

type UpdateSettings struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *UpdateSettings

Update settings for the watcher system index

https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-update-settings.html

func (UpdateSettings) Do

func (r UpdateSettings) Do(ctx context.Context) (bool, error)

Do runs the request through the transport, handle the response and returns a updatesettings.Response

func (*UpdateSettings) Header

func (r *UpdateSettings) Header(key, value string) *UpdateSettings

Header set a key, value pair in the UpdateSettings headers map.

func (*UpdateSettings) HttpRequest

func (r *UpdateSettings) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (UpdateSettings) IsSuccess

func (r UpdateSettings) 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 (UpdateSettings) Perform

func (r UpdateSettings) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.