Packages

case class Role(consulPolicies: List[String], ttl: Duration = Duration.Undefined, maxTtl: Duration = Duration.Undefined, tokenType: TokenType = TokenType.Client, local: Boolean = false) extends Product with Serializable

The configurations of a Consul role in Vault.

ttl

Specifies the TTL for this role. If not provided, the default Vault TTL is used.

maxTtl

Specifies the max TTL for this role. If not provided, the default Vault Max TTL is used.

tokenType

Specifies the type of token to create when using this role.

local

Indicates that the token should not be replicated globally and instead be local to the current datacenter.

Source
Role.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Role
  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 Role(consulPolicies: List[String], ttl: Duration = Duration.Undefined, maxTtl: Duration = Duration.Undefined, tokenType: TokenType = TokenType.Client, local: Boolean = false)

    ttl

    Specifies the TTL for this role. If not provided, the default Vault TTL is used.

    maxTtl

    Specifies the max TTL for this role. If not provided, the default Vault Max TTL is used.

    tokenType

    Specifies the type of token to create when using this role.

    local

    Indicates that the token should not be replicated globally and instead be local to the current datacenter.

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): (Role, B)
    Implicit
    This member is added by an implicit conversion from Role toArrowAssoc[Role] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. val consulPolicies: List[String]
  8. def ensuring(cond: (Role) => Boolean, msg: => Any): Role
    Implicit
    This member is added by an implicit conversion from Role toEnsuring[Role] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Role) => Boolean): Role
    Implicit
    This member is added by an implicit conversion from Role toEnsuring[Role] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Role
    Implicit
    This member is added by an implicit conversion from Role toEnsuring[Role] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Role
    Implicit
    This member is added by an implicit conversion from Role toEnsuring[Role] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val local: Boolean
  16. val maxTtl: Duration
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. val tokenType: TokenType
  23. val ttl: Duration
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Role toStringFormat[Role] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (Role, B)
    Implicit
    This member is added by an implicit conversion from Role toArrowAssoc[Role] 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 fromRole to StringFormat[Role]

Inherited by implicit conversion Ensuring fromRole to Ensuring[Role]

Inherited by implicit conversion ArrowAssoc fromRole to ArrowAssoc[Role]

Ungrouped