Package co.elastic.clients.elasticsearch.security

Class PutRoleRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.PutRoleRequest
All Implemented Interfaces:
ElasticsearchCommonRequest, JsonpSerializable
@JsonpDeserializable
public final class PutRoleRequest
extends RequestBase
implements JsonpSerializable

  • Field Details

  • Constructor Details

  • Method Details

    • name

      public java.lang.String name()
      Required - Role name

      API name: name

    • refresh

      @Nullable public jakarta.json.JsonValue 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

    • applications

      @Nullable public java.util.List<ApplicationPrivileges> applications()
      A list of application privilege entries.

      API name: applications

    • cluster

      @Nullable public java.util.List<ClusterPrivilege> cluster()
      A list of cluster privileges. These privileges define the cluster-level actions for users with this role.

      API name: cluster

    • global

      @Nullable public java.util.Map<java.lang.String,​JsonData> global()
      An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.

      API name: global

    • indices

      @Nullable public java.util.List<IndicesPrivileges> indices()
      A list of indices permissions entries.

      API name: indices

    • metadata

      @Nullable public java.util.Map<java.lang.String,​JsonData> metadata()
      Optional metadata. Within the metadata object, keys that begin with an underscore (_) are reserved for system use.

      API name: metadata

    • runAs

      @Nullable public java.util.List<java.lang.String> runAs()
      A list of users that the owners of this role can impersonate.

      API name: run_as

    • transientMetadata

      @Nullable public TransientMetadata transientMetadata()
      Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If enabled is false, the role is ignored, but is still listed in the response from the authenticate API.

      API name: transient_metadata

    • 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)

    • setupPutRoleRequestDeserializer

      protected static void setupPutRoleRequestDeserializer​(DelegatingDeserializer<PutRoleRequest.Builder> op)