Packages

final class KeyValueV2[F[_]] extends AnyRef

Source
KeyValueV2.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KeyValueV2
  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 KeyValueV2(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): (KeyValueV2[F], B)
    Implicit
    This member is added by an implicit conversion from KeyValueV2[F] toArrowAssoc[KeyValueV2[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[A](path: String, version: Option[Int] = None)(implicit arg0: Decoder[A]): F[A]

    Retrieves the secret data at path assuming it exists.

    Retrieves the secret data at path assuming it exists.

    A

    the type of the secret data.

    path

    the path from which to retrieve the secret data.

    version

    Specifies the version to return. If not set the latest version is returned.

  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. val configuration: F[Configuration]

    Retrieves the current backend level configuration.

  9. def configure(configuration: Configuration): F[Unit]

    Sets backend level configurations that are applied to every key in the key-value store.

  10. def configureAt(path: String, configuration: Configuration): F[Unit]

    Configures the metadata for the secret at the specified path.

    Configures the metadata for the secret at the specified path. If no secret exists at path a new one will be created. If the value does not yet exist, the calling token must have an ACL policy granting the create capability. If the value already exists, the calling token must have an ACL policy granting the update capability.

    path

    the path to update the metadata.

    configuration

    the metadata to update

  11. def delete(path: String): F[Unit]

    Issues a soft delete of the secret's latest version at the specified path.

    Issues a soft delete of the secret's latest version at the specified path. This marks the version as deleted and will stop it from being returned from reads, but the underlying data will not be removed. A delete can be undone using the undelete path.

    path

    the path of the secret to delete

  12. def deleteVersions(path: String, versions: List[Int]): F[Unit]

    Issues a soft delete of the specified versions of the secret.

    Issues a soft delete of the specified versions of the secret. This marks the versions as deleted and will stop them from being returned from reads, but the underlying data will not be removed.

    A delete can be undone using the undelete.

    path

    the path of the secret to delete

    versions

    The versions to be deleted. The versioned data will not be deleted, but it will no longer be returned in normal get requests.

  13. def destroy(path: String): F[Unit]

    Permanently deletes the key metadata and all version data for the specified key.

    Permanently deletes the key metadata and all version data for the specified key. All version history will be removed.

    path

    the path of the secret to delete

  14. def destroyVersions(path: String, versions: List[Int]): F[Unit]

    Permanently removes the specified version data for the provided key and version numbers from the key-value store.

    Permanently removes the specified version data for the provided key and version numbers from the key-value store.

    path

    the path of the secret to destroy.

    versions

    the versions to destroy. Their data will be permanently deleted.

  15. def ensuring(cond: (KeyValueV2[F]) => Boolean, msg: => Any): KeyValueV2[F]
    Implicit
    This member is added by an implicit conversion from KeyValueV2[F] toEnsuring[KeyValueV2[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (KeyValueV2[F]) => Boolean): KeyValueV2[F]
    Implicit
    This member is added by an implicit conversion from KeyValueV2[F] toEnsuring[KeyValueV2[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): KeyValueV2[F]
    Implicit
    This member is added by an implicit conversion from KeyValueV2[F] toEnsuring[KeyValueV2[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): KeyValueV2[F]
    Implicit
    This member is added by an implicit conversion from KeyValueV2[F] toEnsuring[KeyValueV2[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  22. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from KeyValueV2[F] toStringFormat[KeyValueV2[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def list(path: String): F[List[String]]

    Returns a list of key names at the specified location.

    Returns a list of key names at the specified location. Folders are suffixed with /. The input must be a folder; list on a file will not return a value. Note that no policy-based filtering is performed on keys; do not encode sensitive information in key names. The values themselves are not accessible via this command.

    path

    the path to list the secrets keys.

    returns

    the list of keys at path or an empty list if that path does not exist.

  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. val path: String
  31. def read[A](path: String, version: Option[Int] = None)(implicit arg0: Decoder[A]): F[Option[A]]

    Retrieves the secret data at path.

    Retrieves the secret data at path.

    A

    the type of the secret data.

    path

    the path from which to retrieve the secret data.

    version

    the version to return. If not set the latest version is returned.

  32. def readMetadata(path: String): F[Metadata]

    Retrieves the metadata and versions for the secret at the specified path.

    Retrieves the metadata and versions for the secret at the specified path.

    path

    the path of the secret to read.

  33. def readWithVersion[A](path: String, version: Option[Int] = None)(implicit arg0: Decoder[A]): F[Option[Secret[A]]]

    Reads the secret data and metadata at path.

    Reads the secret data and metadata at path.

    A

    the type of the secret data.

    path

    the path from which to retrieve the secret.

    version

    the version to return. If not set the latest version is returned.

  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. def undeleteVersions(path: String, versions: List[Int]): F[Unit]

    Undeletes the data for the provided version and path in the key-value store.

    Undeletes the data for the provided version and path in the key-value store. This restores the data, allowing it to be returned on get requests.

    path

    the path of the secret to undelete

    versions

    The versions to undelete. The versions will be restored and their data will be returned on normal get requests.

  37. def updateMetadata(path: String, configuration: Configuration): F[Unit]

    Alias for configureAt.

    Alias for configureAt. This method exists to make this API similar to the Vault API documentation. However the name is misleading.

  38. val uri: Uri
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  42. def write[A](path: String, secret: A, cas: Option[Int] = None)(implicit arg0: AsObject[A]): F[VersionMetadata]

    Stores a secret of type A at path.

    Stores a secret of type A at path. Given that A can be encoded as a Json Object. If the value does not yet exist, the calling token must have an ACL policy granting the create capability. If the value already exists, the calling token must have an ACL policy granting the update capability.

    A

    the type of the secret to be created.

    path

    the path at which to create the secret.

    secret

    the secret.

    cas

    Set the "cas" value to use a Check-And-Set operation. If not set the write will be allowed. If set to 0 a write will only be allowed if the key doesn’t exist. If the index is non-zero the write will only be allowed if the key’s current version matches the version specified in the cas parameter.

  43. def writeIfNeeded(path: String, secrets: Map[String, String]): F[Unit]

    A special case of write:

    A special case of write:

    • only accepts secrets with type Map[String, String].
    • first performs a read on path and compares the existing secrets with secrets:
      • If the existing secrets contains all secrets no further action is taken.
      • Otherwise the secrets are updated to contain all secrets. For the same key values in secrets take precedence over the values in previous secrets.
      • If no secrets exist in path they will be created there.
    path

    the path at which to create the secret.

    secrets

    the secrets to write/update.

Deprecated Value Members

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

Inherited by implicit conversion Ensuring fromKeyValueV2[F] to Ensuring[KeyValueV2[F]]

Inherited by implicit conversion ArrowAssoc fromKeyValueV2[F] to ArrowAssoc[KeyValueV2[F]]

Ungrouped