Package co.elastic.clients.elasticsearch.security

Class DeleteRoleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.DeleteRoleRequest

public class DeleteRoleRequest
extends RequestBase

Delete roles.

Delete roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The delete roles API cannot remove roles that are defined in roles files.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<DeleteRoleRequest,DeleteRoleResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.delete_role".

Method Summary

Modifier and Type	Method	Description
final String	name()	Required - The name of the role.
static DeleteRoleRequest	of(Function<DeleteRoleRequest.Builder,ObjectBuilder<DeleteRoleRequest>> fn)
final Refresh	refresh()	If true (the default) then refresh 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 then do nothing with refreshes.

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<DeleteRoleRequest,DeleteRoleResponse,ErrorResponse> _ENDPOINT

Endpoint "security.delete_role".

Method Details

of

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

name

public final String name()

Required - The name of the role.

API name: name

refresh

@Nullable
public final Refresh refresh()

If true (the default) then refresh 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 then do nothing with refreshes.

API name: refresh