Packages

case class RoleDefinition(runAs: List[String] = List.empty, cluster: List[String] = List.empty, global: Option[JsonObject] = Option.empty, indices: List[Indice] = List.empty, applications: List[Application] = List.empty, metadata: Option[JsonObject] = Option.empty) extends Product with Serializable

runAs

A list of users that the owners of this role can impersonate. For more information, see Submitting requests on behalf of other users.

cluster

A list of cluster privileges. These privileges define the cluster level actions that users with this role are able to execute.

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. This field is optional.

indices

A list of indices permissions entries.

applications

A list of application privilege entries.

metadata

Optional meta-data. Within the metadata object, keys that begin with _ are reserved for system usage.

Source
RoleDefinition.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RoleDefinition
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RoleDefinition(runAs: List[String] = List.empty, cluster: List[String] = List.empty, global: Option[JsonObject] = Option.empty, indices: List[Indice] = List.empty, applications: List[Application] = List.empty, metadata: Option[JsonObject] = Option.empty)

    runAs

    A list of users that the owners of this role can impersonate. For more information, see Submitting requests on behalf of other users.

    cluster

    A list of cluster privileges. These privileges define the cluster level actions that users with this role are able to execute.

    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. This field is optional.

    indices

    A list of indices permissions entries.

    applications

    A list of application privilege entries.

    metadata

    Optional meta-data. Within the metadata object, keys that begin with _ are reserved for system usage.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (RoleDefinition, B)
    Implicit
    This member is added by an implicit conversion from RoleDefinition toArrowAssoc[RoleDefinition] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. val applications: List[Application]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val cluster: List[String]
  9. def ensuring(cond: (RoleDefinition) => Boolean, msg: => Any): RoleDefinition
    Implicit
    This member is added by an implicit conversion from RoleDefinition toEnsuring[RoleDefinition] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (RoleDefinition) => Boolean): RoleDefinition
    Implicit
    This member is added by an implicit conversion from RoleDefinition toEnsuring[RoleDefinition] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): RoleDefinition
    Implicit
    This member is added by an implicit conversion from RoleDefinition toEnsuring[RoleDefinition] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): RoleDefinition
    Implicit
    This member is added by an implicit conversion from RoleDefinition toEnsuring[RoleDefinition] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from RoleDefinition toStringFormat[RoleDefinition] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. val global: Option[JsonObject]
  18. val indices: List[Indice]
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val metadata: Option[JsonObject]
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. val runAs: List[String]
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def [B](y: B): (RoleDefinition, B)
    Implicit
    This member is added by an implicit conversion from RoleDefinition toArrowAssoc[RoleDefinition] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromRoleDefinition to StringFormat[RoleDefinition]

Inherited by implicit conversion Ensuring fromRoleDefinition to Ensuring[RoleDefinition]

Inherited by implicit conversion ArrowAssoc fromRoleDefinition to ArrowAssoc[RoleDefinition]

Ungrouped