Package co.elastic.clients.elasticsearch.security

Class GetRoleMappingRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.GetRoleMappingRequest

public class GetRoleMappingRequest
extends RequestBase

Retrieves role mappings.

See Also:

API specification

Nested Class Summary

Nested Classes

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

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 Endpoint<GetRoleMappingRequest,GetRoleMappingResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.get_role_mapping".

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	name()	The distinct name that identifies the role mapping.
static GetRoleMappingRequest	of(java.util.function.Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> 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<GetRoleMappingRequest,GetRoleMappingResponse,ErrorResponse> _ENDPOINT

Endpoint "security.get_role_mapping".

Method Details

of

public static GetRoleMappingRequest of(java.util.function.Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> fn)

name

public final java.util.List<java.lang.String> name()

The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. You can specify multiple mapping names as a comma-separated list. If you do not specify this parameter, the API returns information about all role mappings.

API name: name