Documentation ¶
Overview ¶
Creates or updates the user profile on behalf of another user.
Index ¶
- Variables
- type ActivateUserProfile
- func (r *ActivateUserProfile) AccessToken(accesstoken string) *ActivateUserProfile
- func (r ActivateUserProfile) Do(ctx context.Context) (*Response, error)
- func (r *ActivateUserProfile) GrantType(granttype granttype.GrantType) *ActivateUserProfile
- func (r *ActivateUserProfile) Header(key, value string) *ActivateUserProfile
- func (r *ActivateUserProfile) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *ActivateUserProfile) Password(password string) *ActivateUserProfile
- func (r ActivateUserProfile) Perform(ctx context.Context) (*http.Response, error)
- func (r *ActivateUserProfile) Raw(raw io.Reader) *ActivateUserProfile
- func (r *ActivateUserProfile) Request(req *Request) *ActivateUserProfile
- func (r *ActivateUserProfile) Username(username string) *ActivateUserProfile
- type NewActivateUserProfile
- type Request
- type Response
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 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.
func (*ActivateUserProfile) AccessToken ¶ added in v8.9.0
func (r *ActivateUserProfile) AccessToken(accesstoken string) *ActivateUserProfile
API name: access_token
func (ActivateUserProfile) Do ¶
func (r ActivateUserProfile) Do(ctx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a activateuserprofile.Response
func (*ActivateUserProfile) GrantType ¶ added in v8.9.0
func (r *ActivateUserProfile) GrantType(granttype granttype.GrantType) *ActivateUserProfile
API name: grant_type
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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*ActivateUserProfile) Password ¶ added in v8.9.0
func (r *ActivateUserProfile) Password(password string) *ActivateUserProfile
API name: password
func (ActivateUserProfile) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ActivateUserProfile) Raw ¶
func (r *ActivateUserProfile) Raw(raw io.Reader) *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.
func (*ActivateUserProfile) Username ¶ added in v8.9.0
func (r *ActivateUserProfile) Username(username string) *ActivateUserProfile
API name: username
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
type Response ¶ added in v8.7.0
type Response struct { Data map[string]json.RawMessage `json:"data"` Doc_ types.UserProfileHitMetadata `json:"_doc"` Enabled *bool `json:"enabled,omitempty"` Labels map[string]json.RawMessage `json:"labels"` LastSynchronized int64 `json:"last_synchronized"` Uid string `json:"uid"` User types.UserProfileUser `json:"user"` }
Response holds the response body struct for the package activateuserprofile