suggestuserprofiles

Documentation

Overview

Suggest a user profile.

Get suggestions for user profiles that match specified search criteria.

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 NewSuggestUserProfiles
  • func NewSuggestUserProfilesFunc(tp elastictransport.Interface) NewSuggestUserProfiles
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() *Response
• type SuggestUserProfiles
  • func New(tp elastictransport.Interface) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) Data(data ...string) *SuggestUserProfiles
  • func (r SuggestUserProfiles) Do(providedCtx context.Context) (*Response, error)
  • func (r *SuggestUserProfiles) ErrorTrace(errortrace bool) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) FilterPath(filterpaths ...string) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) Header(key, value string) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) Hint(hint types.HintVariant) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *SuggestUserProfiles) Human(human bool) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) Name(name string) *SuggestUserProfiles
  • func (r SuggestUserProfiles) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *SuggestUserProfiles) Pretty(pretty bool) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) Raw(raw io.Reader) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) Request(req *Request) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) Size(size int64) *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 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, the API returns no `data` content.
	// It is an error to specify `data` as both the query parameter and the request
	// body field.
	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 aren't excluded from the response as long as
	// the profile matches the `name` field query.
	Hint *types.Hint `json:"hint,omitempty"`
	// Name A 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 The 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/52c473efb1fb5320a5bac12572d0b285882862fb/specification/security/suggest_user_profiles/Request.ts#L24-L81

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

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {

	// Profiles A list of profile documents, ordered by relevance, that match the search
	// criteria.
	Profiles []types.UserProfile `json:"profiles"`
	// Took The number of milliseconds it took Elasticsearch to run the request.
	Took int64 `json:"took"`
	// Total Metadata about the number of matching profiles.
	Total types.TotalUserProfiles `json:"total"`
}

Response holds the response body struct for the package suggestuserprofiles

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/security/suggest_user_profiles/Response.ts#L29-L44

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

Suggest a user profile.

Get suggestions for user profiles that match specified search criteria.

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-suggest-user-profiles

func (*SuggestUserProfiles) Data

func (r *SuggestUserProfiles) Data(data ...string) *SuggestUserProfiles

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, the API returns no `data` content. It is an error to specify `data` as both the query parameter and the request body field. 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) ErrorTrace

func (r *SuggestUserProfiles) ErrorTrace(errortrace bool) *SuggestUserProfiles

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*SuggestUserProfiles) FilterPath

func (r *SuggestUserProfiles) FilterPath(filterpaths ...string) *SuggestUserProfiles

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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

func (r *SuggestUserProfiles) Hint(hint types.HintVariant) *SuggestUserProfiles

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 aren't excluded from the response as long as the profile matches the `name` field query. API name: hint

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) Human

func (r *SuggestUserProfiles) Human(human bool) *SuggestUserProfiles

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 (*SuggestUserProfiles) Name

func (r *SuggestUserProfiles) Name(name string) *SuggestUserProfiles

A 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

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

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*SuggestUserProfiles) Pretty

func (r *SuggestUserProfiles) Pretty(pretty bool) *SuggestUserProfiles

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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

func (r *SuggestUserProfiles) Size(size int64) *SuggestUserProfiles

The number of profiles to return. API name: size