Package co.elastic.clients.elasticsearch.security

Class RoleDescriptor.AbstractBuilder<BuilderT extends RoleDescriptor.AbstractBuilder<BuilderT>>

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.security.RoleDescriptor.AbstractBuilder<BuilderT>
All Implemented Interfaces:
WithJson<BuilderT>
Direct Known Subclasses:
QueryRole.Builder, RoleDescriptor.Builder
Enclosing class:
RoleDescriptor
public abstract static class RoleDescriptor.AbstractBuilder<BuilderT extends RoleDescriptor.AbstractBuilder<BuilderT>> extends WithJsonObjectBuilderBase<BuilderT>

  • Constructor Details

    • AbstractBuilder

      public AbstractBuilder()

  • Method Details

    • cluster

      public final BuilderT cluster(List<String> list)
      A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.

      API name: cluster

      Adds all elements of list to cluster.

    • cluster

      public final BuilderT cluster(String value, String... values)
      A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.

      API name: cluster

      Adds one or more values to cluster.

    • indices

      public final BuilderT indices(List<IndicesPrivileges> list)
      A list of indices permissions entries.

      API name: indices

      Adds all elements of list to indices.

    • indices

      public final BuilderT indices(IndicesPrivileges value, IndicesPrivileges... values)
      A list of indices permissions entries.

      API name: indices

      Adds one or more values to indices.

    • indices

      public final BuilderT indices(Function<IndicesPrivileges.Builder,ObjectBuilder<IndicesPrivileges>> fn)
      A list of indices permissions entries.

      API name: indices

      Adds a value to indices using a builder lambda.

    • remoteIndices

      public final BuilderT remoteIndices(List<RemoteIndicesPrivileges> list)
      A list of indices permissions for remote clusters.

      API name: remote_indices

      Adds all elements of list to remoteIndices.

    • remoteIndices

      public final BuilderT remoteIndices(RemoteIndicesPrivileges value, RemoteIndicesPrivileges... values)
      A list of indices permissions for remote clusters.

      API name: remote_indices

      Adds one or more values to remoteIndices.

    • remoteIndices

      public final BuilderT remoteIndices(Function<RemoteIndicesPrivileges.Builder,ObjectBuilder<RemoteIndicesPrivileges>> fn)
      A list of indices permissions for remote clusters.

      API name: remote_indices

      Adds a value to remoteIndices using a builder lambda.

    • remoteCluster

      public final BuilderT remoteCluster(List<RemoteClusterPrivileges> list)
      A list of cluster permissions for remote clusters. NOTE: This is limited a subset of the cluster permissions.

      API name: remote_cluster

      Adds all elements of list to remoteCluster.

    • remoteCluster

      public final BuilderT remoteCluster(RemoteClusterPrivileges value, RemoteClusterPrivileges... values)
      A list of cluster permissions for remote clusters. NOTE: This is limited a subset of the cluster permissions.

      API name: remote_cluster

      Adds one or more values to remoteCluster.

    • remoteCluster

      public final BuilderT remoteCluster(Function<RemoteClusterPrivileges.Builder,ObjectBuilder<RemoteClusterPrivileges>> fn)
      A list of cluster permissions for remote clusters. NOTE: This is limited a subset of the cluster permissions.

      API name: remote_cluster

      Adds a value to remoteCluster using a builder lambda.

    • global

      public final BuilderT global(List<GlobalPrivilege> list)
      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

      Adds all elements of list to global.

    • global

      public final BuilderT global(GlobalPrivilege value, GlobalPrivilege... values)
      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

      Adds one or more values to global.

    • global

      public final BuilderT global(Function<GlobalPrivilege.Builder,ObjectBuilder<GlobalPrivilege>> fn)
      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

      Adds a value to global using a builder lambda.

    • applications

      public final BuilderT applications(List<ApplicationPrivileges> list)
      A list of application privilege entries

      API name: applications

      Adds all elements of list to applications.

    • applications

      public final BuilderT applications(ApplicationPrivileges value, ApplicationPrivileges... values)
      A list of application privilege entries

      API name: applications

      Adds one or more values to applications.

    • applications

      public final BuilderT applications(Function<ApplicationPrivileges.Builder,ObjectBuilder<ApplicationPrivileges>> fn)
      A list of application privilege entries

      API name: applications

      Adds a value to applications using a builder lambda.

    • metadata

      public final BuilderT metadata(Map<String,JsonData> map)
      Optional meta-data. Within the metadata object, keys that begin with _ are reserved for system usage.

      API name: metadata

      Adds all entries of map to metadata.

    • metadata

      public final BuilderT metadata(String key, JsonData value)
      Optional meta-data. Within the metadata object, keys that begin with _ are reserved for system usage.

      API name: metadata

      Adds an entry to metadata.

    • runAs

      public final BuilderT runAs(List<String> list)
      A list of users that the API keys can impersonate. NOTE: In Elastic Cloud Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected.

      API name: run_as

      Adds all elements of list to runAs.

    • runAs

      public final BuilderT runAs(String value, String... values)
      A list of users that the API keys can impersonate. NOTE: In Elastic Cloud Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected.

      API name: run_as

      Adds one or more values to runAs.

    • description

      public final BuilderT description(@Nullable String value)
      Optional description of the role descriptor

      API name: description

    • restriction

      public final BuilderT restriction(@Nullable Restriction value)
      Restriction for when the role descriptor is allowed to be effective.

      API name: restriction

    • restriction

      public final BuilderT restriction(Function<Restriction.Builder,ObjectBuilder<Restriction>> fn)
      Restriction for when the role descriptor is allowed to be effective.

      API name: restriction

    • transientMetadata

      public final BuilderT transientMetadata(Map<String,JsonData> map)
      API name: transient_metadata

      Adds all entries of map to transientMetadata.

    • transientMetadata

      public final BuilderT transientMetadata(String key, JsonData value)
      API name: transient_metadata

      Adds an entry to transientMetadata.

    • self

      protected abstract BuilderT self()
      Specified by:
      self in class WithJsonObjectBuilderBase<BuilderT extends RoleDescriptor.AbstractBuilder<BuilderT>>