getsettings

Documentation

Overview

Retrieve settings for the security system indices

Index

• Variables
• type GetSettings
  • func New(tp elastictransport.Interface) *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
  • func NewGetSettingsFunc(tp elastictransport.Interface) NewGetSettings

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 GetSettings

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

func New

func New(tp elastictransport.Interface) *GetSettings

Retrieve settings for the security system indices

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

func (GetSettings) Do

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

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

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

func (GetSettings) IsSuccess

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

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

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

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.