activateuserprofile

Documentation

Overview

Creates or updates the user profile on behalf of another user.

Index

• Variables
• type ActivateUserProfile
  • func New(tp elastictransport.Interface) *ActivateUserProfile
  • func (r ActivateUserProfile) Do(ctx context.Context) (*http.Response, error)
  • func (r *ActivateUserProfile) Header(key, value string) *ActivateUserProfile
  • func (r *ActivateUserProfile) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ActivateUserProfile) Raw(raw json.RawMessage) *ActivateUserProfile
  • func (r *ActivateUserProfile) Request(req *Request) *ActivateUserProfile
• type NewActivateUserProfile
  • func NewActivateUserProfileFunc(tp elastictransport.Interface) NewActivateUserProfile
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) AccessToken(accesstoken string) *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) GrantType(granttype granttype.GrantType) *RequestBuilder
  • func (rb *RequestBuilder) Password(password string) *RequestBuilder
  • func (rb *RequestBuilder) Username(username string) *RequestBuilder

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 ActivateUserProfile

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

func New

func New(tp elastictransport.Interface) *ActivateUserProfile

Creates or updates the user profile on behalf of another user.

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

func (ActivateUserProfile) Do

func (r ActivateUserProfile) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*ActivateUserProfile) Header

func (r *ActivateUserProfile) Header(key, value string) *ActivateUserProfile

Header set a key, value pair in the ActivateUserProfile headers map.

func (*ActivateUserProfile) HttpRequest

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

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

func (*ActivateUserProfile) Raw

func (r *ActivateUserProfile) Raw(raw json.RawMessage) *ActivateUserProfile

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*ActivateUserProfile) Request

func (r *ActivateUserProfile) Request(req *Request) *ActivateUserProfile

Request allows to set the request property with the appropriate payload.

type NewActivateUserProfile

type NewActivateUserProfile func() *ActivateUserProfile

NewActivateUserProfile type alias for index.

func NewActivateUserProfileFunc

func NewActivateUserProfileFunc(tp elastictransport.Interface) NewActivateUserProfile

NewActivateUserProfileFunc returns a new instance of ActivateUserProfile 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 {
	AccessToken *string `json:"access_token,omitempty"`

	GrantType granttype.GrantType `json:"grant_type"`

	Password *string `json:"password,omitempty"`

	Username *string `json:"username,omitempty"`
}

Request holds the request body struct for the package activateuserprofile

https://github.com/elastic/elasticsearch-specification/blob/1b56d7e58f5c59f05d1641c6d6a8117c5e01d741/specification/security/activate_user_profile/Request.ts#L23-L37

type RequestBuilder

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

RequestBuilder is the builder API for the activateuserprofile.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

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

func (*RequestBuilder) AccessToken

func (rb *RequestBuilder) AccessToken(accesstoken string) *RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) GrantType

func (rb *RequestBuilder) GrantType(granttype granttype.GrantType) *RequestBuilder

func (*RequestBuilder) Password

func (rb *RequestBuilder) Password(password string) *RequestBuilder

func (*RequestBuilder) Username

func (rb *RequestBuilder) Username(username string) *RequestBuilder