trait SecretUtils extends Serializable with WithHelpMethods
SecretUtils provides utilities for working with secrets.
- Alphabetic
- By Inheritance
- SecretUtils
- WithHelpMethods
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def get(scope: String, key: String): String
Gets the string representation of a secret value with scope and key.
Gets the string representation of a secret value with scope and key. This API assumes the secret is encoded as UTF-8 bytes. This will always be the case if you use the
string_valuewrite API.Example:
dbutils.secrets.get("scope1", "key1")
- scope
Scope in which the secret was created
- key
Key with which the secret was created
- abstract def getBytes(scope: String, key: String): Array[Byte]
Gets the bytes representation of a secret value with scope and key.
Gets the bytes representation of a secret value with scope and key.
Example:
dbutils.secrets.getBytes("scope1", "key1")
- scope
Scope in which the secret was created
- key
Key with which the secret was created
- abstract def help(moduleOrMethod: String): Unit
- Definition Classes
- WithHelpMethods
- abstract def help(): Unit
- Definition Classes
- WithHelpMethods
- abstract def list(scope: String): Seq[SecretMetadata]
Lists secret metadata for secrets within a scope.
Lists secret metadata for secrets within a scope.
Example:
dbutils.secrets.list("scope2")- scope
Scope in which secrets were created
- returns
A list of secrets in the given scope.
- abstract def listScopes(): Seq[SecretScope]
Lists all secret scopes.
Lists all secret scopes.
Example:
dbutils.secrets.listScopes()
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def apply(): SecretUtils.this.type
- Definition Classes
- WithHelpMethods
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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])
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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()