updateuserprofiledata

Documentation

Overview

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

Index

• Variables
• type NewUpdateUserProfileData
  • func NewUpdateUserProfileDataFunc(tp elastictransport.Interface) NewUpdateUserProfileData
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type UpdateUserProfileData
  • func New(tp elastictransport.Interface) *UpdateUserProfileData
  • func (r UpdateUserProfileData) Do(ctx context.Context) (*Response, error)
  • func (r *UpdateUserProfileData) Header(key, value string) *UpdateUserProfileData
  • func (r *UpdateUserProfileData) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *UpdateUserProfileData) IfPrimaryTerm(v string) *UpdateUserProfileData
  • func (r *UpdateUserProfileData) IfSeqNo(v string) *UpdateUserProfileData
  • func (r UpdateUserProfileData) Perform(ctx context.Context) (*http.Response, error)
  • func (r *UpdateUserProfileData) Raw(raw io.Reader) *UpdateUserProfileData
  • func (r *UpdateUserProfileData) Refresh(enum refresh.Refresh) *UpdateUserProfileData
  • func (r *UpdateUserProfileData) Request(req *Request) *UpdateUserProfileData
  • func (r *UpdateUserProfileData) Uid(v string) *UpdateUserProfileData

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 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]json.RawMessage `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]json.RawMessage `json:"labels,omitempty"`
}

Request holds the request body struct for the package updateuserprofiledata

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

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpdateUserProfileData

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

func New

func New(tp elastictransport.Interface) *UpdateUserProfileData

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

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

func (UpdateUserProfileData) Do

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

Do runs the request through the transport, handle the response and returns a updateuserprofiledata.Response

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(v string) *UpdateUserProfileData

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

func (*UpdateUserProfileData) IfSeqNo

func (r *UpdateUserProfileData) IfSeqNo(v string) *UpdateUserProfileData

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

func (UpdateUserProfileData) Perform

func (r UpdateUserProfileData) Perform(ctx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*UpdateUserProfileData) Raw

func (r *UpdateUserProfileData) Raw(raw io.Reader) *UpdateUserProfileData

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

func (r *UpdateUserProfileData) Refresh(enum refresh.Refresh) *UpdateUserProfileData

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

func (r *UpdateUserProfileData) Request(req *Request) *UpdateUserProfileData

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

func (*UpdateUserProfileData) Uid

func (r *UpdateUserProfileData) Uid(v string) *UpdateUserProfileData

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