final class Leases[F[_]] extends AnyRef
- Alphabetic
- By Inheritance
- Leases
- 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): (Leases[F], B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply(name: String): F[Lease]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (Leases[F]) => Boolean, msg: => Any): Leases[F]
- def ensuring(cond: (Leases[F]) => Boolean): Leases[F]
- def ensuring(cond: Boolean, msg: => Any): Leases[F]
- def ensuring(cond: Boolean): Leases[F]
- 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
- def get(id: String): F[Option[Lease]]
- id
the id of the lease.
- returns
the metadata associated with the lease with
id. If no lease with thatidexists a None will be returned.
- 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
- def list(prefix: String): F[List[String]]
This endpoint returns a list of lease ids.
This endpoint returns a list of lease ids. This endpoint requires 'sudo' capability.
- prefix
the prefix for which to list leases.
- 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
- def renew(id: String, increment: FiniteDuration = 0.second): F[LeaseRenew]
Renews a lease, requesting to extend the lease.
Renews a lease, requesting to extend the lease.
- id
Specifies the ID of the lease to extend.
- increment
Specifies the requested amount of time to extend the lease.
- def revoke(id: String): F[Unit]
Revokes a lease immediately.
Revokes a lease immediately.
- id
Specifies the ID of the lease to revoke.
- def revokeForce(prefix: String): F[Unit]
This endpoint revokes all secrets or tokens generated under a given prefix immediately.
This endpoint revokes all secrets or tokens generated under a given prefix immediately. Unlike revokePrefix, this ignores backend errors encountered during revocation. This is potentially very dangerous and should only be used in specific emergency situations where errors in the backend or the connected backend service prevent normal revocation.
By ignoring these errors, Vault abdicates responsibility for ensuring that the issued credentials or secrets are properly revoked and/or cleaned up. Access to this endpoint should be tightly controlled.
This endpoint requires 'sudo' capability.
- prefix
the prefix to revoke.
- def revokePrefix(prefix: String): F[Unit]
This endpoint revokes all secrets (via a lease ID prefix) or tokens (via the tokens' path property) generated under a given prefix immediately.
This endpoint revokes all secrets (via a lease ID prefix) or tokens (via the tokens' path property) generated under a given prefix immediately. This requires
sudocapability and access to it should be tightly controlled as it can be used to revoke very large numbers of secrets/tokens at once.- prefix
the prefix to revoke.
- 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): (Leases[F], B)
- Implicit
- This member is added by an implicit conversion from Leases[F] toArrowAssoc[Leases[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.