Documentation
¶
Overview ¶
Enable a user profile.
Enable user profiles to make them visible in user profile searches.
NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice.
When you activate a user profile, it's automatically enabled and visible in user profile searches. If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.
Index ¶
- Variables
- type EnableUserProfile
- func (r EnableUserProfile) Do(providedCtx context.Context) (*Response, error)
- func (r *EnableUserProfile) ErrorTrace(errortrace bool) *EnableUserProfile
- func (r *EnableUserProfile) FilterPath(filterpaths ...string) *EnableUserProfile
- func (r *EnableUserProfile) Header(key, value string) *EnableUserProfile
- func (r *EnableUserProfile) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *EnableUserProfile) Human(human bool) *EnableUserProfile
- func (r EnableUserProfile) IsSuccess(providedCtx context.Context) (bool, error)
- func (r EnableUserProfile) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *EnableUserProfile) Pretty(pretty bool) *EnableUserProfile
- func (r *EnableUserProfile) Refresh(refresh refresh.Refresh) *EnableUserProfile
- type NewEnableUserProfile
- 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 EnableUserProfile ¶
type EnableUserProfile struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *EnableUserProfile
Enable a user profile.
Enable user profiles to make them visible in user profile searches.
NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice.
When you activate a user profile, it's automatically enabled and visible in user profile searches. If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.
func (EnableUserProfile) Do ¶
func (r EnableUserProfile) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a enableuserprofile.Response
func (*EnableUserProfile) ErrorTrace ¶
func (r *EnableUserProfile) ErrorTrace(errortrace bool) *EnableUserProfile
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*EnableUserProfile) FilterPath ¶
func (r *EnableUserProfile) FilterPath(filterpaths ...string) *EnableUserProfile
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*EnableUserProfile) Header ¶
func (r *EnableUserProfile) Header(key, value string) *EnableUserProfile
Header set a key, value pair in the EnableUserProfile headers map.
func (*EnableUserProfile) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*EnableUserProfile) Human ¶
func (r *EnableUserProfile) Human(human bool) *EnableUserProfile
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 (EnableUserProfile) IsSuccess ¶
func (r EnableUserProfile) 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 (EnableUserProfile) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*EnableUserProfile) Pretty ¶
func (r *EnableUserProfile) Pretty(pretty bool) *EnableUserProfile
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*EnableUserProfile) Refresh ¶
func (r *EnableUserProfile) Refresh(refresh refresh.Refresh) *EnableUserProfile
Refresh If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', nothing is done with refreshes. API name: refresh
type NewEnableUserProfile ¶
type NewEnableUserProfile func(uid string) *EnableUserProfile
NewEnableUserProfile type alias for index.
func NewEnableUserProfileFunc ¶
func NewEnableUserProfileFunc(tp elastictransport.Interface) NewEnableUserProfile
NewEnableUserProfileFunc returns a new instance of EnableUserProfile with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files