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
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) Data(arg []string) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Hint(hint *types.HintBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Name(name string) *RequestBuilder
  • func (rb *RequestBuilder) Size(size int64) *RequestBuilder
• type SuggestUserProfiles
  • func New(tp elastictransport.Interface) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) Data(value string) *SuggestUserProfiles
  • func (r SuggestUserProfiles) Do(ctx context.Context) (*http.Response, error)
  • func (r *SuggestUserProfiles) Header(key, value string) *SuggestUserProfiles
  • func (r *SuggestUserProfiles) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *SuggestUserProfiles) Raw(raw json.RawMessage) *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/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/security/suggest_user_profiles/Request.ts#L24-L66

type RequestBuilder

type RequestBuilder struct {
	// contains filtered or unexported fields
}

RequestBuilder is the builder API for the suggestuserprofiles.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) Data

func (rb *RequestBuilder) Data(arg []string) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Hint

func (rb *RequestBuilder) Hint(hint *types.HintBuilder) *RequestBuilder

func (*RequestBuilder) Name

func (rb *RequestBuilder) Name(name string) *RequestBuilder

func (*RequestBuilder) Size

func (rb *RequestBuilder) Size(size int64) *RequestBuilder

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(value 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) (*http.Response, error)

Do runs the http.Request through the provided transport.

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

func (r *SuggestUserProfiles) Raw(raw json.RawMessage) *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.