Documentation
¶
Overview ¶
Returns cluster settings.
Index ¶
- Variables
- type GetSettings
- func (r GetSettings) Do(providedCtx context.Context) (*Response, error)
- 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) 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) Timeout(duration string) *GetSettings
- type NewGetSettings
- type Response
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
Returns cluster settings.
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) 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 ¶
HttpRequest returns the http.Request object built from the given parameters.
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 ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
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 ¶ added in v8.7.0
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
Source Files