com.databricks.sdk.service.catalog

Class SecretsUcAPI

java.lang.Object

com.databricks.sdk.service.catalog.SecretsUcAPI

@Generated
public class SecretsUcAPI
extends Object

A secret is a Unity Catalog securable object that stores sensitive credential data (such as passwords, tokens, and keys) within a three-level namespace (**catalog_name.schema_name.secret_name**).

Secrets can be managed using standard Unity Catalog permissions and are scoped to a schema within a catalog.

Constructor Summary

Constructors

Constructor and Description
SecretsUcAPI(ApiClient apiClient) Regular-use constructor
SecretsUcAPI(SecretsUcService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Secret	createSecret(CreateSecretRequest request) Creates a new secret in Unity Catalog.
void	deleteSecret(DeleteSecretRequest request) Deletes a secret by its three-level (fully qualified) name.
void	deleteSecret(String fullName)
Secret	getSecret(GetSecretRequest request) Gets a secret by its three-level (fully qualified) name.
Secret	getSecret(String fullName)
SecretsUcService	impl()
Iterable<Secret>	listSecrets(ListSecretsRequest request) Lists secrets in Unity Catalog.
Secret	updateSecret(UpdateSecretRequest request) Updates an existing secret in Unity Catalog.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecretsUcAPI

public SecretsUcAPI(ApiClient apiClient)

Regular-use constructor

SecretsUcAPI

public SecretsUcAPI(SecretsUcService mock)

Constructor for mocks

Method Detail

createSecret

public Secret createSecret(CreateSecretRequest request)

Creates a new secret in Unity Catalog.

You must be the owner of the parent schema or have the **CREATE_SECRET** and **USE SCHEMA** privileges on the parent schema and **USE CATALOG** on the parent catalog.

The secret is stored in the specified catalog and schema, and the **value** field contains the sensitive data to be securely stored.

deleteSecret

public void deleteSecret(String fullName)

deleteSecret

public void deleteSecret(DeleteSecretRequest request)

Deletes a secret by its three-level (fully qualified) name.

You must be the owner of the secret or a metastore admin.

getSecret

public Secret getSecret(String fullName)

getSecret

public Secret getSecret(GetSecretRequest request)

Gets a secret by its three-level (fully qualified) name.

You must be a metastore admin, the owner of the secret, or have the **MANAGE** privilege on the secret.

The secret value isn't returned by default. To retrieve it, you must also have the **READ_SECRET** privilege and set **include_value** to true in the request.

listSecrets

public Iterable<Secret> listSecrets(ListSecretsRequest request)

Lists secrets in Unity Catalog.

You must be a metastore admin, the owner of the secret, or have the **MANAGE** privilege on the secret.

Both **catalog_name** and **schema_name** must be specified together to filter secrets within a specific schema. Results are paginated; use the **page_token** field from the response to retrieve subsequent pages.

updateSecret

public Secret updateSecret(UpdateSecretRequest request)

Updates an existing secret in Unity Catalog.

You must be the owner of the secret or a metastore admin. If you are a metastore admin, only the **owner** field can be changed.

Use the **update_mask** field to specify which fields to update. Supported updatable fields include **value**, **comment**, **owner**, and **expire_time**.

impl

public SecretsUcService impl()