Documentation
¶
Overview ¶
Delete application privileges.
To use this API, you must have one of the following privileges:
* The `manage_security` cluster privilege (or a greater privilege such as `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request.
Index ¶
- Variables
- type DeletePrivileges
- func (r DeletePrivileges) Do(providedCtx context.Context) (Response, error)
- func (r *DeletePrivileges) ErrorTrace(errortrace bool) *DeletePrivileges
- func (r *DeletePrivileges) FilterPath(filterpaths ...string) *DeletePrivileges
- func (r *DeletePrivileges) Header(key, value string) *DeletePrivileges
- func (r *DeletePrivileges) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *DeletePrivileges) Human(human bool) *DeletePrivileges
- func (r DeletePrivileges) IsSuccess(providedCtx context.Context) (bool, error)
- func (r DeletePrivileges) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DeletePrivileges) Pretty(pretty bool) *DeletePrivileges
- func (r *DeletePrivileges) Refresh(refresh refresh.Refresh) *DeletePrivileges
- type NewDeletePrivileges
- 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 DeletePrivileges ¶
type DeletePrivileges struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeletePrivileges
Delete application privileges.
To use this API, you must have one of the following privileges:
* The `manage_security` cluster privilege (or a greater privilege such as `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delete-privileges
func (DeletePrivileges) Do ¶
func (r DeletePrivileges) Do(providedCtx context.Context) (Response, error)
Do runs the request through the transport, handle the response and returns a deleteprivileges.Response
func (*DeletePrivileges) ErrorTrace ¶
func (r *DeletePrivileges) ErrorTrace(errortrace bool) *DeletePrivileges
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*DeletePrivileges) FilterPath ¶
func (r *DeletePrivileges) FilterPath(filterpaths ...string) *DeletePrivileges
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*DeletePrivileges) Header ¶
func (r *DeletePrivileges) Header(key, value string) *DeletePrivileges
Header set a key, value pair in the DeletePrivileges headers map.
func (*DeletePrivileges) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*DeletePrivileges) Human ¶
func (r *DeletePrivileges) Human(human bool) *DeletePrivileges
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 (DeletePrivileges) IsSuccess ¶
func (r DeletePrivileges) 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 (DeletePrivileges) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeletePrivileges) Pretty ¶
func (r *DeletePrivileges) Pretty(pretty bool) *DeletePrivileges
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*DeletePrivileges) Refresh ¶
func (r *DeletePrivileges) Refresh(refresh refresh.Refresh) *DeletePrivileges
Refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. API name: refresh
type NewDeletePrivileges ¶
type NewDeletePrivileges func(application, name string) *DeletePrivileges
NewDeletePrivileges type alias for index.
func NewDeletePrivilegesFunc ¶
func NewDeletePrivilegesFunc(tp elastictransport.Interface) NewDeletePrivileges
NewDeletePrivilegesFunc returns a new instance of DeletePrivileges with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files