Documentation
¶
Overview ¶
Retrieves user profiles for the given unique ID(s).
Index ¶
- Variables
- type GetUserProfile
- func (r *GetUserProfile) Data(data ...string) *GetUserProfile
- func (r GetUserProfile) Do(providedCtx context.Context) (*Response, error)
- func (r *GetUserProfile) Header(key, value string) *GetUserProfile
- func (r *GetUserProfile) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetUserProfile) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetUserProfile) Perform(providedCtx context.Context) (*http.Response, error)
- 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
Retrieves user profiles for the given unique ID(s).
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html
func (*GetUserProfile) Data ¶
func (r *GetUserProfile) Data(data ...string) *GetUserProfile
Data 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) 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.
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 ¶ added in v8.7.0
type Response struct {
Errors *types.GetUserProfileErrors `json:"errors,omitempty"`
Profiles []types.UserProfileWithMetadata `json:"profiles"`
}
Response holds the response body struct for the package getuserprofile
Source Files