Packages

final class Leases[F[_]] extends AnyRef

Source
Leases.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Leases
  2. AnyRef
  3. 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 Leases(path: String, uri: Uri)(implicit arg0: Concurrent[F], arg1: Client[F], token: Raw)

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): (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
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def apply(name: String): F[Lease]
  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() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (Leases[F]) => Boolean, msg: => Any): Leases[F]
    Implicit
    This member is added by an implicit conversion from Leases[F] toEnsuring[Leases[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Leases[F]) => Boolean): Leases[F]
    Implicit
    This member is added by an implicit conversion from Leases[F] toEnsuring[Leases[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Leases[F]
    Implicit
    This member is added by an implicit conversion from Leases[F] toEnsuring[Leases[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Leases[F]
    Implicit
    This member is added by an implicit conversion from Leases[F] toEnsuring[Leases[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Leases[F] toStringFormat[Leases[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. 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 that id exists a None will be returned.

  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. 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.

  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. val path: String
  24. 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.

  25. def revoke(id: String): F[Unit]

    Revokes a lease immediately.

    Revokes a lease immediately.

    id

    Specifies the ID of the lease to revoke.

  26. 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.

  27. 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 sudo capability 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.

  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. val uri: Uri
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. 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 [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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromLeases[F] to StringFormat[Leases[F]]

Inherited by implicit conversion Ensuring fromLeases[F] to Ensuring[Leases[F]]

Inherited by implicit conversion ArrowAssoc fromLeases[F] to ArrowAssoc[Leases[F]]

Ungrouped