Package google.registry.privileges.secretmanager

Class SecretManagerClientImpl

java.lang.Object

google.registry.privileges.secretmanager.SecretManagerClientImpl

All Implemented Interfaces:

SecretManagerClient

public class SecretManagerClientImpl
extends java.lang.Object
implements SecretManagerClient

Implements SecretManagerClient on Google Cloud Platform.

Nested Class Summary

Nested classes/interfaces inherited from interface google.registry.privileges.secretmanager.SecretManagerClient

SecretManagerClient.NoSuchSecretResourceException, SecretManagerClient.SecretAlreadyExistsException, SecretManagerClient.SecretManagerException, SecretManagerClient.SecretVersionState

Method Summary

Modifier and Type	Method	Description
java.lang.String	addSecretVersion(java.lang.String secretId, java.lang.String data)	Adds a new version of data to a secret.
void	createSecret(java.lang.String secretId)	Creates a new secret in the Cloud Secret Manager with no data.
void	deleteSecret(java.lang.String secretId)	Deletes a secret from the Secret Manager.
void	destroySecretVersion(java.lang.String secretId, java.lang.String version)	Destroys a secret version.
void	disableSecretVersion(java.lang.String secretId, java.lang.String version)	Disables a secret version.
void	enableSecretVersion(java.lang.String secretId, java.lang.String version)	Enables a secret version.
java.lang.String	getProject()	Returns the project name with which this client is associated.
java.lang.String	getSecretData(java.lang.String secretId, java.util.Optional<java.lang.String> version)	Returns the data of a secret at the given version.
java.lang.Iterable<java.lang.String>	listSecrets()	Returns all secret IDs in the Cloud Secret Manager.
java.lang.Iterable<SecretManagerClient.SecretVersionState>	listSecretVersions(java.lang.String secretId)	Returns the SecretManagerClient.SecretVersionState of all secrets with secretId.
boolean	secretExists(java.lang.String secretId)	Checks if a secret with the given secretId already exists.

Methods inherited from class java.lang.Object

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

Methods inherited from interface google.registry.privileges.secretmanager.SecretManagerClient

createSecretIfAbsent, listSecretVersions

Method Detail

getProject

public java.lang.String getProject()

Description copied from interface: SecretManagerClient

Returns the project name with which this client is associated.

Specified by:

getProject in interface SecretManagerClient

createSecret

public void createSecret(java.lang.String secretId)

Description copied from interface: SecretManagerClient

Creates a new secret in the Cloud Secret Manager with no data.

Use addVersion to add data to this secret.

Specified by:

createSecret in interface SecretManagerClient

Parameters:

secretId - The ID of the secret, must be unique in a project

secretExists

public boolean secretExists(java.lang.String secretId)

Description copied from interface: SecretManagerClient

Checks if a secret with the given secretId already exists.

Specified by:

secretExists in interface SecretManagerClient

listSecrets

public java.lang.Iterable<java.lang.String> listSecrets()

Description copied from interface: SecretManagerClient

Returns all secret IDs in the Cloud Secret Manager.

Specified by:

listSecrets in interface SecretManagerClient

listSecretVersions

public java.lang.Iterable<SecretManagerClient.SecretVersionState> listSecretVersions(java.lang.String secretId)

Description copied from interface: SecretManagerClient

Returns the SecretManagerClient.SecretVersionState of all secrets with secretId.

Specified by:

listSecretVersions in interface SecretManagerClient

addSecretVersion

public java.lang.String addSecretVersion(java.lang.String secretId,
                                         java.lang.String data)

Description copied from interface: SecretManagerClient

Adds a new version of data to a secret.

Specified by:

addSecretVersion in interface SecretManagerClient

Parameters:

secretId - The ID of the secret

data - The secret data to be stored in Cloud Secret Manager, encoded in utf-8 charset

Returns:

The version string of the newly added secret data

getSecretData

public java.lang.String getSecretData(java.lang.String secretId,
                                      java.util.Optional<java.lang.String> version)

Description copied from interface: SecretManagerClient

Returns the data of a secret at the given version.

Specified by:

getSecretData in interface SecretManagerClient

Parameters:

secretId - The ID of the secret

version - The version of the secret to fetch. If not provided, the latest version will be returned

enableSecretVersion

public void enableSecretVersion(java.lang.String secretId,
                                java.lang.String version)

Description copied from interface: SecretManagerClient

Enables a secret version.

Specified by:

enableSecretVersion in interface SecretManagerClient

Parameters:

secretId - The ID of the secret

version - The version of the secret to fetch. If not provided, the latest version will be returned

disableSecretVersion

public void disableSecretVersion(java.lang.String secretId,
                                 java.lang.String version)

Description copied from interface: SecretManagerClient

Disables a secret version.

Specified by:

disableSecretVersion in interface SecretManagerClient

Parameters:

secretId - The ID of the secret

version - The version of the secret to fetch. If not provided, the latest version will be returned

destroySecretVersion

public void destroySecretVersion(java.lang.String secretId,
                                 java.lang.String version)

Description copied from interface: SecretManagerClient

Destroys a secret version.

Specified by:

destroySecretVersion in interface SecretManagerClient

Parameters:

secretId - The ID of the secret

version - The version of the secret to destroy

deleteSecret

public void deleteSecret(java.lang.String secretId)

Description copied from interface: SecretManagerClient

Deletes a secret from the Secret Manager. All versions of this secret will be destroyed.

Specified by:

deleteSecret in interface SecretManagerClient

Parameters:

secretId - The ID of the secret to be deleted