Documentation
¶
Overview ¶
Get suggestions for user profiles that match specified search criteria.
Index ¶
- Variables
- type NewSuggestUserProfiles
- type Request
- type Response
- type SuggestUserProfiles
- func (r *SuggestUserProfiles) Data(data ...string) *SuggestUserProfiles
- func (r SuggestUserProfiles) Do(providedCtx context.Context) (*Response, error)
- func (r *SuggestUserProfiles) Header(key, value string) *SuggestUserProfiles
- func (r *SuggestUserProfiles) Hint(hint *types.Hint) *SuggestUserProfiles
- func (r *SuggestUserProfiles) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *SuggestUserProfiles) Name(name string) *SuggestUserProfiles
- func (r SuggestUserProfiles) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *SuggestUserProfiles) Raw(raw io.Reader) *SuggestUserProfiles
- func (r *SuggestUserProfiles) Request(req *Request) *SuggestUserProfiles
- func (r *SuggestUserProfiles) Size(size int64) *SuggestUserProfiles
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 NewSuggestUserProfiles ¶
type NewSuggestUserProfiles func() *SuggestUserProfiles
NewSuggestUserProfiles type alias for index.
func NewSuggestUserProfilesFunc ¶
func NewSuggestUserProfilesFunc(tp elastictransport.Interface) NewSuggestUserProfiles
NewSuggestUserProfilesFunc returns a new instance of SuggestUserProfiles with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Request ¶
type Request struct {
// 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.
Data []string `json:"data,omitempty"`
// Hint Extra search criteria to improve relevance of the suggestion result.
// Profiles matching the spcified hint are ranked higher in the response.
// Profiles not matching the hint don't exclude the profile from the response
// as long as the profile matches the `name` field query.
Hint *types.Hint `json:"hint,omitempty"`
// Name Query string used to match name-related fields in user profile documents.
// Name-related fields are the user's `username`, `full_name`, and `email`.
Name *string `json:"name,omitempty"`
// Size Number of profiles to return.
Size *int64 `json:"size,omitempty"`
}
Request holds the request body struct for the package suggestuserprofiles
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
func (*Request) UnmarshalJSON ¶ added in v8.12.1
type Response ¶ added in v8.7.0
type Response struct {
Profiles []types.UserProfile `json:"profiles"`
Took int64 `json:"took"`
Total types.TotalUserProfiles `json:"total"`
}
Response holds the response body struct for the package suggestuserprofiles
type SuggestUserProfiles ¶
type SuggestUserProfiles struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *SuggestUserProfiles
Get suggestions for user profiles that match specified search criteria.
func (*SuggestUserProfiles) Data ¶
func (r *SuggestUserProfiles) Data(data ...string) *SuggestUserProfiles
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 (SuggestUserProfiles) Do ¶
func (r SuggestUserProfiles) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a suggestuserprofiles.Response
func (*SuggestUserProfiles) Header ¶
func (r *SuggestUserProfiles) Header(key, value string) *SuggestUserProfiles
Header set a key, value pair in the SuggestUserProfiles headers map.
func (*SuggestUserProfiles) Hint ¶ added in v8.9.0
func (r *SuggestUserProfiles) Hint(hint *types.Hint) *SuggestUserProfiles
Hint Extra search criteria to improve relevance of the suggestion result. Profiles matching the spcified hint are ranked higher in the response. Profiles not matching the hint don't exclude the profile from the response as long as the profile matches the `name` field query. API name: hint
func (*SuggestUserProfiles) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*SuggestUserProfiles) Name ¶ added in v8.9.0
func (r *SuggestUserProfiles) Name(name string) *SuggestUserProfiles
Name Query string used to match name-related fields in user profile documents. Name-related fields are the user's `username`, `full_name`, and `email`. API name: name
func (SuggestUserProfiles) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*SuggestUserProfiles) Raw ¶
func (r *SuggestUserProfiles) Raw(raw io.Reader) *SuggestUserProfiles
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*SuggestUserProfiles) Request ¶
func (r *SuggestUserProfiles) Request(req *Request) *SuggestUserProfiles
Request allows to set the request property with the appropriate payload.
func (*SuggestUserProfiles) Size ¶ added in v8.9.0
func (r *SuggestUserProfiles) Size(size int64) *SuggestUserProfiles
Size Number of profiles to return. API name: size
Source Files