Documentation ¶
Overview ¶
Enables authentication as a user and retrieve information about the authenticated user.
Index ¶
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 Authenticate ¶
type Authenticate struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Authenticate
Enables authentication as a user and retrieve information about the authenticated user.
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html
func (*Authenticate) Header ¶
func (r *Authenticate) Header(key, value string) *Authenticate
Header set a key, value pair in the Authenticate headers map.
func (*Authenticate) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
type NewAuthenticate ¶
type NewAuthenticate func() *Authenticate
NewAuthenticate type alias for index.
func NewAuthenticateFunc ¶
func NewAuthenticateFunc(tp elastictransport.Interface) NewAuthenticate
NewAuthenticateFunc returns a new instance of Authenticate with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.