Package co.elastic.clients.elasticsearch.security

Class UpdateUserProfileDataRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.UpdateUserProfileDataRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class UpdateUserProfileDataRequest
extends RequestBase
implements JsonpSerializable

Update user profile data.

Update specific data for the user profile that is associated with a unique ID.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdateUserProfileDataRequest.Builder	Builder for UpdateUserProfileDataRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<UpdateUserProfileDataRequest>	_DESERIALIZER	Json deserializer for UpdateUserProfileDataRequest
static final Endpoint<UpdateUserProfileDataRequest,UpdateUserProfileDataResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.update_user_profile_data".

Method Summary

Modifier and Type	Method	Description
final Map<String,JsonData>	data()	Non-searchable data that you want to associate with the user profile.
final Long	ifPrimaryTerm()	Only perform the operation if the document has this primary term.
final Long	ifSeqNo()	Only perform the operation if the document has this sequence number.
final Map<String,JsonData>	labels()	Searchable data that you want to associate with the user profile.
static UpdateUserProfileDataRequest	of(Function<UpdateUserProfileDataRequest.Builder,ObjectBuilder<UpdateUserProfileDataRequest>> fn)
final 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.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupUpdateUserProfileDataRequestDeserializer(ObjectDeserializer<UpdateUserProfileDataRequest.Builder> op)
final String	uid()	Required - A unique identifier for the user profile.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<UpdateUserProfileDataRequest> _DESERIALIZER

Json deserializer for UpdateUserProfileDataRequest

_ENDPOINT

public static final Endpoint<UpdateUserProfileDataRequest,UpdateUserProfileDataResponse,ErrorResponse> _ENDPOINT

Endpoint "security.update_user_profile_data".

Method Details

of

public static UpdateUserProfileDataRequest of(Function<UpdateUserProfileDataRequest.Builder,ObjectBuilder<UpdateUserProfileDataRequest>> fn)

data

public final Map<String,JsonData> data()

Non-searchable data that you want to associate with the user profile. This field supports a nested data structure.

API name: data

ifPrimaryTerm

@Nullable
public final Long ifPrimaryTerm()

Only perform the operation if the document has this primary term.

API name: if_primary_term

ifSeqNo

@Nullable
public final Long ifSeqNo()

Only perform the operation if the document has this sequence number.

API name: if_seq_no

labels

public final Map<String,JsonData> labels()

Searchable data that you want to associate with the user profile. This field supports a nested data structure.

API name: labels

refresh

@Nullable
public final 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

uid

public final String uid()

Required - A unique identifier for the user profile.

API name: uid

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupUpdateUserProfileDataRequestDeserializer

protected static void setupUpdateUserProfileDataRequestDeserializer(ObjectDeserializer<UpdateUserProfileDataRequest.Builder> op)