Package co.elastic.clients.elasticsearch.security

Class HasPrivilegesRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.HasPrivilegesRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class HasPrivilegesRequest
extends RequestBase
implements JsonpSerializable

Check user privileges.

Determine whether the specified user has a specified list of privileges. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<HasPrivilegesRequest>	_DESERIALIZER	Json deserializer for HasPrivilegesRequest
static final Endpoint<HasPrivilegesRequest,HasPrivilegesResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.has_privileges".

Method Summary

Modifier and Type	Method	Description
final List<ApplicationPrivilegesCheck>	application()	API name: application
final List<String>	cluster()	A list of the cluster privileges that you want to check.
final List<IndexPrivilegesCheck>	index()	API name: index
static HasPrivilegesRequest	of(Function<HasPrivilegesRequest.Builder,ObjectBuilder<HasPrivilegesRequest>> fn)
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	setupHasPrivilegesRequestDeserializer(ObjectDeserializer<HasPrivilegesRequest.Builder> op)
final String	user()	Username

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<HasPrivilegesRequest> _DESERIALIZER

Json deserializer for HasPrivilegesRequest

_ENDPOINT

public static final Endpoint<HasPrivilegesRequest,HasPrivilegesResponse,ErrorResponse> _ENDPOINT

Endpoint "security.has_privileges".

Method Details

of

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

application

public final List<ApplicationPrivilegesCheck> application()

API name: application

cluster

public final List<String> cluster()

A list of the cluster privileges that you want to check.

API name: cluster

index

public final List<IndexPrivilegesCheck> index()

API name: index

user

@Nullable
public final String user()

Username

API name: user

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)

setupHasPrivilegesRequestDeserializer

protected static void setupHasPrivilegesRequestDeserializer(ObjectDeserializer<HasPrivilegesRequest.Builder> op)