Documentation
¶
Overview ¶
Update application specific data for the user profile of the given unique ID.
Index ¶
- Variables
- type NewUpdateUserProfileData
- type Request
- type RequestBuilder
- type UpdateUserProfileData
- func (r UpdateUserProfileData) Do(ctx context.Context) (*http.Response, error)
- func (r *UpdateUserProfileData) Header(key, value string) *UpdateUserProfileData
- func (r *UpdateUserProfileData) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *UpdateUserProfileData) IfPrimaryTerm(value string) *UpdateUserProfileData
- func (r *UpdateUserProfileData) IfSeqNo(value string) *UpdateUserProfileData
- func (r *UpdateUserProfileData) Raw(raw json.RawMessage) *UpdateUserProfileData
- func (r *UpdateUserProfileData) Refresh(enum refresh.Refresh) *UpdateUserProfileData
- func (r *UpdateUserProfileData) Request(req *Request) *UpdateUserProfileData
- func (r *UpdateUserProfileData) Uid(v string) *UpdateUserProfileData
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 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
type RequestBuilder ¶
type RequestBuilder struct {
// contains filtered or unexported fields
}
RequestBuilder is the builder API for the updateuserprofiledata.Request
func NewRequestBuilder ¶
func NewRequestBuilder() *RequestBuilder
NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder
func (*RequestBuilder) Build ¶
func (rb *RequestBuilder) Build() *Request
Build finalize the chain and returns the Request struct.
func (*RequestBuilder) Data ¶
func (rb *RequestBuilder) Data(value map[string]interface{}) *RequestBuilder
func (*RequestBuilder) FromJSON ¶
func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
FromJSON allows to load an arbitrary json into the request structure
func (*RequestBuilder) Labels ¶
func (rb *RequestBuilder) Labels(value map[string]interface{}) *RequestBuilder
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.
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 ¶
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 ¶
func (r *UpdateUserProfileData) IfSeqNo(value string) *UpdateUserProfileData
IfSeqNo Only perform the operation if the document has this sequence number. API name: if_seq_no
func (*UpdateUserProfileData) Raw ¶
func (r *UpdateUserProfileData) Raw(raw json.RawMessage) *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
Source Files