final class GenerateRoot[F[_]] extends AnyRef
- Alphabetic
- By Inheritance
- GenerateRoot
- AnyRef
- Any
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def ->[B](y: B): (GenerateRoot[F], B)
- Implicit
- This member is added by an implicit conversion from GenerateRoot[F] toArrowAssoc[GenerateRoot[F]] 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
- val cancel: F[Unit]
Cancels any in-progress root generation attempt.
Cancels any in-progress root generation attempt. This clears any progress made. This must be called to change the OTP or PGP key being used.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (GenerateRoot[F]) => Boolean, msg: => Any): GenerateRoot[F]
- Implicit
- This member is added by an implicit conversion from GenerateRoot[F] toEnsuring[GenerateRoot[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (GenerateRoot[F]) => Boolean): GenerateRoot[F]
- Implicit
- This member is added by an implicit conversion from GenerateRoot[F] toEnsuring[GenerateRoot[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): GenerateRoot[F]
- Implicit
- This member is added by an implicit conversion from GenerateRoot[F] toEnsuring[GenerateRoot[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): GenerateRoot[F]
- Implicit
- This member is added by an implicit conversion from GenerateRoot[F] toEnsuring[GenerateRoot[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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 GenerateRoot[F] toStringFormat[GenerateRoot[F]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val path: String
- val progress: F[RootGenerationProgress]
- returns
the configuration and progress of the current root generation attempt.
- def put(keyShare: String, nonce: String): F[RootGenerationProgress]
This endpoint is used to enter a single master key share to progress the root generation attempt.
This endpoint is used to enter a single master key share to progress the root generation attempt. If the threshold number of master key shares is reached, Vault will complete the root generation and issue the new token. Otherwise, this API must be called multiple times until that threshold is met. The attempt nonce must be provided with each call.
- keyShare
Specifies a single master key share.
- nonce
Specifies the nonce of the attempt.
- def start(pgpKey: Option[String] = None): F[RootGenerationProgress]
Start a new root generation attempt.
Start a new root generation attempt. Only a single root generation attempt can take place at a time.
- pgpKey
Specifies a base64-encoded PGP public key. The raw bytes of the token will be encrypted with this value before being returned to the final unseal key provider.
- returns
the configuration and progress of the current root generation attempt.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- val uri: Uri
- 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): (GenerateRoot[F], B)
- Implicit
- This member is added by an implicit conversion from GenerateRoot[F] toArrowAssoc[GenerateRoot[F]] 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.