suggestuserprofiles

Documentation

Overview

Get suggestions for user profiles that match specified search criteria.

Index

• Variables
• type NewSuggestUserProfiles
  • func NewSuggestUserProfilesFunc(tp elastictransport.Interface) NewSuggestUserProfiles
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type SuggestUserProfiles
  • func New(tp elastictransport.Interface) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) Data(v string) *SuggestUserProfiles
  • func (r SuggestUserProfiles) Do(ctx context.Context) (*Response, error)
  • func (r *SuggestUserProfiles) Header(key, value string) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r SuggestUserProfiles) Perform(ctx context.Context) (*http.Response, error)
  • func (r *SuggestUserProfiles) Raw(raw io.Reader) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) Request(req *Request) *SuggestUserProfiles

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.

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

https://github.com/elastic/elasticsearch-specification/blob/363111664e81786557afe06e68221018847b3676/specification/security/suggest_user_profiles/Request.ts#L24-L66

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {
	Profiles []types.UserProfile     `json:"profiles"`
	Took     int64                   `json:"took"`
	Total    types.TotalUserProfiles `json:"total"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

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.

https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-suggest-user-profile.html

func (*SuggestUserProfiles) Data

func (r *SuggestUserProfiles) Data(v 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(ctx 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) HttpRequest

func (r *SuggestUserProfiles) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (SuggestUserProfiles) Perform

func (r SuggestUserProfiles) Perform(ctx context.Context) (*http.Response, error)

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.