Package co.elastic.clients.elasticsearch.security

Class GetPrivilegesRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.GetPrivilegesRequest

public class GetPrivilegesRequest
extends RequestBase

Get application privileges.

To use this API, you must have one of the following privileges:

• The read_security cluster privilege (or a greater privilege such as manage_security or all).
• The "Manage Application Privileges" global privilege for the application being referenced in the request.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 Endpoint<GetPrivilegesRequest,GetPrivilegesResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.get_privileges".

Method Summary

Modifier and Type	Method	Description
final String	application()	The name of the application.
final List<String>	name()	The name of the privilege.
static GetPrivilegesRequest	of(Function<GetPrivilegesRequest.Builder,ObjectBuilder<GetPrivilegesRequest>> fn)

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

_ENDPOINT

public static final Endpoint<GetPrivilegesRequest,GetPrivilegesResponse,ErrorResponse> _ENDPOINT

Endpoint "security.get_privileges".

Method Details

of

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

application

@Nullable
public final String application()

The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications.

API name: application

name

public final List<String> name()

The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application.

API name: name