Packages

abstract class AliasCRUD[F[_], T <: Alias] extends AnyRef

Source
Identity.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AliasCRUD
  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 AliasCRUD(basePath: String, baseUri: Uri, baseName: String)(implicit arg0: Concurrent[F], arg1: Client[F], arg2: Decoder[T], token: Raw)

Abstract Value Members

  1. abstract def computeAliasId(name: String, canonicalId: String, mountAccessor: String): F[String]
    Attributes
    protected

Concrete 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): (AliasCRUD[F, T], B)
    Implicit
    This member is added by an implicit conversion from AliasCRUD[F, T] toArrowAssoc[AliasCRUD[F, T]] 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(id: String): F[T]

    Gets the alias with the given id.

    Gets the alias with the given id.

    id

    the id of the alias.

  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()
  8. def create(name: String, canonicalId: String, mountAccessor: String): F[String]

    Creates a new alias for a .

    Creates a new alias for a .

    name

    name for the alias.

    canonicalId

    ID of to which this alias belongs to.

    mountAccessor

    mount accessor which this alias belongs to. Can be consulted with:

    vaultClient.sys.auth.list().map { mountedAuths => mountedAuths(s"$path/").accessor }
    returns

    the id of the created alias.

    Note

    this method it not idempotent. If the alias already exists Vault will return NoContent. Unfortunately there is nothing we can do, since we don't know the existing alias id, nor can we update the alias via the name.

  9. def delete(id: String): F[Unit]

    Deletes a alias.

    Deletes a alias.

    id

    identifier of the alias.

  10. def ensuring(cond: (AliasCRUD[F, T]) => Boolean, msg: => Any): AliasCRUD[F, T]
    Implicit
    This member is added by an implicit conversion from AliasCRUD[F, T] toEnsuring[AliasCRUD[F, T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (AliasCRUD[F, T]) => Boolean): AliasCRUD[F, T]
    Implicit
    This member is added by an implicit conversion from AliasCRUD[F, T] toEnsuring[AliasCRUD[F, T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): AliasCRUD[F, T]
    Implicit
    This member is added by an implicit conversion from AliasCRUD[F, T] toEnsuring[AliasCRUD[F, T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): AliasCRUD[F, T]
    Implicit
    This member is added by an implicit conversion from AliasCRUD[F, T] toEnsuring[AliasCRUD[F, T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AliasCRUD[F, T] toStringFormat[AliasCRUD[F, T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. def get(id: String): F[Option[T]]

    Gets the alias with the given id.

    Gets the alias with the given id.

    id

    the id of the alias.

    returns

    if a alias with id exists a Some will be returned. None otherwise.

  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val list: F[List[String]]

    List aliases by their identifiers.

  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. val path: String
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. def update(id: String, name: String, canonicalId: String, mountAccessor: String): F[Unit]

    Updates an existing alias.

    Updates an existing alias.

    id

    ID of the alias.

    name

    name of the alias.

    canonicalId

    ID of to which this alias belongs to.

    mountAccessor

    mount accessor which this alias belongs to.

  30. val uri: Uri
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def [B](y: B): (AliasCRUD[F, T], B)
    Implicit
    This member is added by an implicit conversion from AliasCRUD[F, T] toArrowAssoc[AliasCRUD[F, T]] 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 fromAliasCRUD[F, T] to StringFormat[AliasCRUD[F, T]]

Inherited by implicit conversion Ensuring fromAliasCRUD[F, T] to Ensuring[AliasCRUD[F, T]]

Inherited by implicit conversion ArrowAssoc fromAliasCRUD[F, T] to ArrowAssoc[AliasCRUD[F, T]]

Ungrouped