updateuserprofiledata

package
v8.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 11, 2023 License: Apache-2.0 Imports: 10 Imported by: 4

Documentation

Overview

Update application specific data for the user profile of the given unique ID.

Index

Constants

This section is empty.

Variables

View Source
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 NewUpdateUserProfileData

type NewUpdateUserProfileData func(uid string) *UpdateUserProfileData

NewUpdateUserProfileData type alias for index.

func NewUpdateUserProfileDataFunc

func NewUpdateUserProfileDataFunc(tp elastictransport.Interface) NewUpdateUserProfileData

NewUpdateUserProfileDataFunc returns a new instance of UpdateUserProfileData 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 Non-searchable data that you want to associate with the user profile.
	// This field supports a nested data structure.
	Data map[string]interface{} `json:"data,omitempty"`
	// Labels Searchable data that you want to associate with the user profile. This
	// field supports a nested data structure.
	Labels map[string]interface{} `json:"labels,omitempty"`
}

Request holds the request body struct for the package updateuserprofiledata

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/update_user_profile_data/Request.ts#L27-L70

func NewRequest added in v8.5.0

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0

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

FromJSON allows to load an arbitrary json into the request structure

type UpdateUserProfileData

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

func (UpdateUserProfileData) Do

Do runs the http.Request through the provided transport.

func (*UpdateUserProfileData) Header

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

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

func (*UpdateUserProfileData) HttpRequest

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

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

func (*UpdateUserProfileData) IfPrimaryTerm

func (r *UpdateUserProfileData) IfPrimaryTerm(value string) *UpdateUserProfileData

IfPrimaryTerm Only perform the operation if the document has this primary term. API name: if_primary_term

func (*UpdateUserProfileData) IfSeqNo

IfSeqNo Only perform the operation if the document has this sequence number. API name: if_seq_no

func (*UpdateUserProfileData) Raw

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

func (*UpdateUserProfileData) Refresh

Refresh If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search, if 'wait_for' then wait for a refresh to make this operation visible to search, if 'false' do nothing with refreshes. API name: refresh

func (*UpdateUserProfileData) Request

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

func (*UpdateUserProfileData) Uid

Uid A unique identifier for the user profile. API Name: uid

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL