case class CreateOptions(displayName: String = "token", policies: List[String] = List.empty, noDefaultPolicy: Boolean = false, noParent: Boolean = false, numUses: Int = 0, renewable: Boolean = true, ttl: Duration = Duration.Undefined, explicitMaxTtl: Duration = Duration.Undefined, period: Duration = Duration.Undefined, id: Option[String] = None, meta: Map[String, String] = Map.empty) extends Product with Serializable
- displayName
The display name of the token.
- policies
A list of policies for the token. This must be a subset of the policies belonging to the token making the request, unless root. If not specified, defaults to all the policies of the calling token.
- noDefaultPolicy
If true the default policy will not be contained in this token's policy set.
- noParent
If true and set by a root caller, the token will not have the parent token of the caller. This creates a token with no parent.
- numUses
The maximum uses for the given token. This can be used to create a one-time-token or limited use token. The value of 0 has no limit to the number of uses.
- renewable
Set to false to disable the ability of the token to be renewed past its initial TTL. Setting the value to true will allow the token to be renewable up to the system/mount maximum TTL.
- ttl
The TTL period of the token, provided as "1h", where hour is the largest suffix. If not provided, the token is valid for the default lease TTL, or indefinitely if the root policy is used.
- explicitMaxTtl
If set, the token will have an explicit max TTL set upon it. This maximum token TTL cannot be changed later, and unlike with normal tokens, updates to the system/mount max TTL value will have no effect at renewal time -- the token will never be able to be renewed or used past the value set at issue time.
- period
If specified, the token will be periodic; it will have no maximum TTL (unless an "explicit-max-ttl" is also set) but every renewal will use the given period. Requires a root/sudo token to use.
- id
The ID of the client token. Can only be specified by a root token. Otherwise, the token ID is a randomly generated value.
- meta
A map of string to string valued metadata. This is passed through to the audit devices.
- Source
- CreateOptions.scala
- Alphabetic
- By Inheritance
- CreateOptions
- Serializable
- Product
- Equals
- AnyRef
- Any
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CreateOptions(displayName: String = "token", policies: List[String] = List.empty, noDefaultPolicy: Boolean = false, noParent: Boolean = false, numUses: Int = 0, renewable: Boolean = true, ttl: Duration = Duration.Undefined, explicitMaxTtl: Duration = Duration.Undefined, period: Duration = Duration.Undefined, id: Option[String] = None, meta: Map[String, String] = Map.empty)
- displayName
The display name of the token.
- policies
A list of policies for the token. This must be a subset of the policies belonging to the token making the request, unless root. If not specified, defaults to all the policies of the calling token.
- noDefaultPolicy
If true the default policy will not be contained in this token's policy set.
- noParent
If true and set by a root caller, the token will not have the parent token of the caller. This creates a token with no parent.
- numUses
The maximum uses for the given token. This can be used to create a one-time-token or limited use token. The value of 0 has no limit to the number of uses.
- renewable
Set to false to disable the ability of the token to be renewed past its initial TTL. Setting the value to true will allow the token to be renewable up to the system/mount maximum TTL.
- ttl
The TTL period of the token, provided as "1h", where hour is the largest suffix. If not provided, the token is valid for the default lease TTL, or indefinitely if the root policy is used.
- explicitMaxTtl
If set, the token will have an explicit max TTL set upon it. This maximum token TTL cannot be changed later, and unlike with normal tokens, updates to the system/mount max TTL value will have no effect at renewal time -- the token will never be able to be renewed or used past the value set at issue time.
- period
If specified, the token will be periodic; it will have no maximum TTL (unless an "explicit-max-ttl" is also set) but every renewal will use the given period. Requires a root/sudo token to use.
- id
The ID of the client token. Can only be specified by a root token. Otherwise, the token ID is a randomly generated value.
- meta
A map of string to string valued metadata. This is passed through to the audit devices.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def ->[B](y: B): (CreateOptions, B)
- Implicit
- This member is added by an implicit conversion from CreateOptions toArrowAssoc[CreateOptions] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val displayName: String
- def ensuring(cond: (CreateOptions) => Boolean, msg: => Any): CreateOptions
- Implicit
- This member is added by an implicit conversion from CreateOptions toEnsuring[CreateOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (CreateOptions) => Boolean): CreateOptions
- Implicit
- This member is added by an implicit conversion from CreateOptions toEnsuring[CreateOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): CreateOptions
- Implicit
- This member is added by an implicit conversion from CreateOptions toEnsuring[CreateOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): CreateOptions
- Implicit
- This member is added by an implicit conversion from CreateOptions toEnsuring[CreateOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val explicitMaxTtl: Duration
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from CreateOptions toStringFormat[CreateOptions] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val id: Option[String]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val meta: Map[String, String]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val noDefaultPolicy: Boolean
- val noParent: Boolean
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val numUses: Int
- val period: Duration
- val policies: List[String]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val renewable: Boolean
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val ttl: Duration
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def →[B](y: B): (CreateOptions, B)
- Implicit
- This member is added by an implicit conversion from CreateOptions toArrowAssoc[CreateOptions] 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.