Class GetRoleRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.GetRoleRequest
public class GetRoleRequest extends RequestBase
The role management APIs are generally the preferred way to manage roles,
rather than using file-based role management. The get roles API cannot
retrieve roles that are defined in roles files.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetRoleRequest.Builder
Builder forGetRoleRequest
.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<GetRoleRequest,GetRoleResponse,ErrorResponse>
_ENDPOINT
Endpoint "security.get_role
". -
Method Summary
Modifier and Type Method Description java.util.List<java.lang.String>
name()
The name of the role.static GetRoleRequest
of(java.util.function.Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> 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
Endpoint "security.get_role
".
-
-
Method Details
-
of
public static GetRoleRequest of(java.util.function.Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn) -
name
public final java.util.List<java.lang.String> name()The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about all roles.API name:
name
-