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

funcNew¶

func New(tpelastictransport.Interface) *GetSettings

Get security index settings.

Get the user-configurable settings for the security internal index(`.security` and associated indices).Only a subset of the index settings — those that are user-configurable—willbe shown.This includes:

* `index.auto_expand_replicas`* `index.number_of_replicas`

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

func (GetSettings)Do¶

func (rGetSettings) Do(providedCtxcontext.Context) (*Response,error)

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

func (*GetSettings)ErrorTrace¶added inv8.18.0

func (r *GetSettings) ErrorTrace(errortracebool) *GetSettings

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace

func (*GetSettings)FilterPath¶added inv8.18.0

func (r *GetSettings) FilterPath(filterpaths ...string) *GetSettings

FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path

func (*GetSettings)Header¶

func (r *GetSettings) Header(key, valuestring) *GetSettings

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

func (*GetSettings)HttpRequest¶

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

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

func (*GetSettings)Human¶added inv8.18.0

func (r *GetSettings) Human(humanbool) *GetSettings

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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human

func (GetSettings)IsSuccess¶

func (rGetSettings) IsSuccess(providedCtxcontext.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)MasterTimeout¶added inv8.18.0

func (r *GetSettings) MasterTimeout(durationstring) *GetSettings

MasterTimeout Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails andreturns an error.API name: master_timeout

func (GetSettings)Perform¶

func (rGetSettings) Perform(providedCtxcontext.Context) (*http.Response,error)

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

func (*GetSettings)Pretty¶added inv8.18.0

func (r *GetSettings) Pretty(prettybool) *GetSettings

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty

type NewGetSettings func() *GetSettings

funcNewGetSettingsFunc¶

func NewGetSettingsFunc(tpelastictransport.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.

type Response struct {// Security Settings for the index used for most security configuration, including native// realm users and roles configured with the API.Securitytypes.SecuritySettings `json:"security"`// SecurityProfile Settings for the index used to store profile information.SecurityProfiletypes.SecuritySettings `json:"security-profile"`// SecurityTokens Settings for the index used to store tokens.SecurityTokenstypes.SecuritySettings `json:"security-tokens"`}

funcNewResponse¶added inv8.18.0

func NewResponse() *Response

NewResponse returns a Response