Documentation
¶
Overview ¶
Updates the cluster settings.
Index ¶
- Variables
- type NewPutSettings
- type PutSettings
- func (r PutSettings) Do(providedCtx context.Context) (*Response, error)
- func (r *PutSettings) FlatSettings(flatsettings bool) *PutSettings
- func (r *PutSettings) Header(key, value string) *PutSettings
- func (r *PutSettings) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PutSettings) MasterTimeout(duration string) *PutSettings
- func (r PutSettings) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PutSettings) Persistent(persistent map[string]json.RawMessage) *PutSettings
- func (r *PutSettings) Raw(raw io.Reader) *PutSettings
- func (r *PutSettings) Request(req *Request) *PutSettings
- func (r *PutSettings) Timeout(duration string) *PutSettings
- func (r *PutSettings) Transient(transient map[string]json.RawMessage) *PutSettings
- type Request
- 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 NewPutSettings ¶
type NewPutSettings func() *PutSettings
NewPutSettings type alias for index.
func NewPutSettingsFunc ¶
func NewPutSettingsFunc(tp elastictransport.Interface) NewPutSettings
NewPutSettingsFunc returns a new instance of PutSettings with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PutSettings ¶
type PutSettings struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PutSettings
Updates the cluster settings.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html
func (PutSettings) Do ¶
func (r PutSettings) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a putsettings.Response
func (*PutSettings) FlatSettings ¶
func (r *PutSettings) FlatSettings(flatsettings bool) *PutSettings
FlatSettings Return settings in flat format (default: false) API name: flat_settings
func (*PutSettings) Header ¶
func (r *PutSettings) Header(key, value string) *PutSettings
Header set a key, value pair in the PutSettings headers map.
func (*PutSettings) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutSettings) MasterTimeout ¶
func (r *PutSettings) MasterTimeout(duration string) *PutSettings
MasterTimeout Explicit operation timeout for connection to master node API name: master_timeout
func (PutSettings) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PutSettings) Persistent ¶ added in v8.9.0
func (r *PutSettings) Persistent(persistent map[string]json.RawMessage) *PutSettings
API name: persistent
func (*PutSettings) Raw ¶
func (r *PutSettings) Raw(raw io.Reader) *PutSettings
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*PutSettings) Request ¶
func (r *PutSettings) Request(req *Request) *PutSettings
Request allows to set the request property with the appropriate payload.
func (*PutSettings) Timeout ¶
func (r *PutSettings) Timeout(duration string) *PutSettings
Timeout Explicit operation timeout API name: timeout
func (*PutSettings) Transient ¶ added in v8.9.0
func (r *PutSettings) Transient(transient map[string]json.RawMessage) *PutSettings
API name: transient
type Request ¶
type Request struct {
Persistent map[string]json.RawMessage `json:"persistent,omitempty"`
Transient map[string]json.RawMessage `json:"transient,omitempty"`
}
Request holds the request body struct for the package putsettings
type Response ¶ added in v8.7.0
type Response struct {
Acknowledged bool `json:"acknowledged"`
Persistent map[string]json.RawMessage `json:"persistent"`
Transient map[string]json.RawMessage `json:"transient"`
}
Response holds the response body struct for the package putsettings
Source Files