Documentation
¶
Overview ¶
Get a user profile.
Get a user's profile using the unique profile ID.
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.
Index ¶
- Variables
- type GetUserProfile
- func (r *GetUserProfile) Data(data ...string) *GetUserProfile
- func (r GetUserProfile) Do(providedCtx context.Context) (*Response, error)
- func (r *GetUserProfile) ErrorTrace(errortrace bool) *GetUserProfile
- func (r *GetUserProfile) FilterPath(filterpaths ...string) *GetUserProfile
- func (r *GetUserProfile) Header(key, value string) *GetUserProfile
- func (r *GetUserProfile) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetUserProfile) Human(human bool) *GetUserProfile
- func (r GetUserProfile) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetUserProfile) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetUserProfile) Pretty(pretty bool) *GetUserProfile
- type NewGetUserProfile
- 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 GetUserProfile ¶
type GetUserProfile struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetUserProfile
Get a user profile.
Get a user's profile using the unique profile ID.
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.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-user-profile
func (*GetUserProfile) Data ¶
func (r *GetUserProfile) Data(data ...string) *GetUserProfile
Data A comma-separated list of filters for the `data` field of the profile document. To return all content use `data=*`. To return a subset of content use `data=<key>` to retrieve content nested under the specified `<key>`. By default returns no `data` content. API name: data
func (GetUserProfile) Do ¶
func (r GetUserProfile) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a getuserprofile.Response
func (*GetUserProfile) ErrorTrace ¶
func (r *GetUserProfile) ErrorTrace(errortrace bool) *GetUserProfile
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*GetUserProfile) FilterPath ¶
func (r *GetUserProfile) FilterPath(filterpaths ...string) *GetUserProfile
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*GetUserProfile) Header ¶
func (r *GetUserProfile) Header(key, value string) *GetUserProfile
Header set a key, value pair in the GetUserProfile headers map.
func (*GetUserProfile) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetUserProfile) Human ¶
func (r *GetUserProfile) Human(human bool) *GetUserProfile
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 (GetUserProfile) IsSuccess ¶
func (r GetUserProfile) 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 (GetUserProfile) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetUserProfile) Pretty ¶
func (r *GetUserProfile) Pretty(pretty bool) *GetUserProfile
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
type NewGetUserProfile ¶
type NewGetUserProfile func(uid string) *GetUserProfile
NewGetUserProfile type alias for index.
func NewGetUserProfileFunc ¶
func NewGetUserProfileFunc(tp elastictransport.Interface) NewGetUserProfile
NewGetUserProfileFunc returns a new instance of GetUserProfile with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶
type Response struct { Errors *types.GetUserProfileErrors `json:"errors,omitempty"` // Profiles A successful call returns the JSON representation of the user profile and its // internal versioning numbers. // The API returns an empty object if no profile document is found for the // provided `uid`. // The content of the data field is not returned by default to avoid // deserializing a potential large payload. Profiles []types.UserProfileWithMetadata `json:"profiles"` }
Response holds the response body struct for the package getuserprofile