The highest tagged major version isv9.
disableuser
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
- Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Disable users.
Disable users in the native realm.By default, when you create users, they are enabled.You can use this API to revoke a user's access to Elasticsearch.
Index¶
- Variables
- type DisableUser
- func (r DisableUser) Do(providedCtx context.Context) (*Response, error)
- func (r *DisableUser) ErrorTrace(errortrace bool) *DisableUser
- func (r *DisableUser) FilterPath(filterpaths ...string) *DisableUser
- func (r *DisableUser) Header(key, value string) *DisableUser
- func (r *DisableUser) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *DisableUser) Human(human bool) *DisableUser
- func (r DisableUser) IsSuccess(providedCtx context.Context) (bool, error)
- func (r DisableUser) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DisableUser) Pretty(pretty bool) *DisableUser
- func (r *DisableUser) Refresh(refresh refresh.Refresh) *DisableUser
- type NewDisableUser
- 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¶
typeDisableUser¶
type DisableUser struct {// contains filtered or unexported fields}funcNew¶
func New(tpelastictransport.Interface) *DisableUser
Disable users.
Disable users in the native realm.By default, when you create users, they are enabled.You can use this API to revoke a user's access to Elasticsearch.
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html
func (DisableUser)Do¶
func (rDisableUser) Do(providedCtxcontext.Context) (*Response,error)
Do runs the request through the transport, handle the response and returns a disableuser.Response
func (*DisableUser)ErrorTrace¶added inv8.14.0
func (r *DisableUser) ErrorTrace(errortracebool) *DisableUser
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace
func (*DisableUser)FilterPath¶added inv8.14.0
func (r *DisableUser) FilterPath(filterpaths ...string) *DisableUser
FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path
func (*DisableUser)Header¶
func (r *DisableUser) Header(key, valuestring) *DisableUser
Header set a key, value pair in the DisableUser headers map.
func (*DisableUser)HttpRequest¶
HttpRequest returns the http.Request object built from thegiven parameters.
func (*DisableUser)Human¶added inv8.14.0
func (r *DisableUser) Human(humanbool) *DisableUser
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 (DisableUser)IsSuccess¶
func (rDisableUser) 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 (DisableUser)Perform¶added inv8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DisableUser)Pretty¶added inv8.14.0
func (r *DisableUser) Pretty(prettybool) *DisableUser
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty
func (*DisableUser)Refresh¶
func (r *DisableUser) Refresh(refreshrefresh.Refresh) *DisableUser
Refresh If `true` (the default) then refresh the affected shards to make thisoperation visible to search, if `wait_for` then wait for a refresh to makethis operation visible to search, if `false` then do nothing with refreshes.API name: refresh
typeNewDisableUser¶
type NewDisableUser func(usernamestring) *DisableUser
NewDisableUser type alias for index.
funcNewDisableUserFunc¶
func NewDisableUserFunc(tpelastictransport.Interface)NewDisableUser
NewDisableUserFunc returns a new instance of DisableUser with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.
Source Files