getsettings

Documentation

Overview

Get cluster-wide settings. By default, it returns only settings that have been explicitly defined.

Index

• Variables
• type GetSettings
  • func New(tp elastictransport.Interface) *GetSettings
  • func (r GetSettings) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetSettings) ErrorTrace(errortrace bool) *GetSettings
  • func (r *GetSettings) FilterPath(filterpaths ...string) *GetSettings
  • func (r *GetSettings) FlatSettings(flatsettings bool) *GetSettings
  • func (r *GetSettings) Header(key, value string) *GetSettings
  • func (r *GetSettings) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetSettings) Human(human bool) *GetSettings
  • func (r *GetSettings) IncludeDefaults(includedefaults bool) *GetSettings
  • func (r GetSettings) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetSettings) MasterTimeout(duration string) *GetSettings
  • func (r GetSettings) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetSettings) Pretty(pretty bool) *GetSettings
  • func (r *GetSettings) Timeout(duration string) *GetSettings
• type NewGetSettings
  • func NewGetSettingsFunc(tp elastictransport.Interface) NewGetSettings
• type Response
  • func NewResponse() *Response

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

Get cluster-wide settings. By default, it returns only settings that have been explicitly defined.

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

func (GetSettings) Do

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

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

func (*GetSettings) ErrorTrace

func (r *GetSettings) ErrorTrace(errortrace bool) *GetSettings

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

func (*GetSettings) FilterPath

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

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

func (*GetSettings) FlatSettings

func (r *GetSettings) FlatSettings(flatsettings bool) *GetSettings

FlatSettings If `true`, returns settings in flat format. API name: flat_settings

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) Human

func (r *GetSettings) Human(human bool) *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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*GetSettings) IncludeDefaults

func (r *GetSettings) IncludeDefaults(includedefaults bool) *GetSettings

IncludeDefaults If `true`, returns default cluster settings from the local node. API name: include_defaults

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) MasterTimeout

func (r *GetSettings) MasterTimeout(duration string) *GetSettings

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

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.

func (*GetSettings) Pretty

func (r *GetSettings) Pretty(pretty bool) *GetSettings

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

func (*GetSettings) Timeout

func (r *GetSettings) Timeout(duration string) *GetSettings

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

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.

type Response

type Response struct {
	Defaults   map[string]json.RawMessage `json:"defaults,omitempty"`
	Persistent map[string]json.RawMessage `json:"persistent"`
	Transient  map[string]json.RawMessage `json:"transient"`
}

Response holds the response body struct for the package getsettings

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/cluster/get_settings/ClusterGetSettingsResponse.ts#L23-L29

func NewResponse

func NewResponse() *Response

NewResponse returns a Response