org.springframework.cloud.gcp.secretmanager

Interface SecretManagerOperations

All Known Implementing Classes:

SecretManagerTemplate

public interface SecretManagerOperations

Describes supported operations that one can perform on the Secret Manager API.

Since:

1.2.2

Author:

Daniel Zou

Method Summary

Modifier and Type	Method and Description
void	createSecret(String secretId, byte[] payload) Creates a new secret or a new version of existing secret with the provided payload.
void	createSecret(String secretId, String payload) Creates a new secret or a new version of existing secret with the provided payload.
byte[]	getSecretBytes(String secretId) Gets the secret payload of the specified secretId at the latest version.
byte[]	getSecretBytes(String secretId, String versionName) Gets the secret payload of the specified secretId at version versionName.
com.google.protobuf.ByteString	getSecretByteString(String secretId, String versionName) Gets the secret payload of the specified secretId at version versionName.
String	getSecretString(String secretId) Gets the secret payload of the specified secretId at the latest version.
String	getSecretString(String secretId, String versionName) Gets the secret payload of the specified secretId at version versionName.
boolean	secretExists(String secretId) Returns true if there already exists a secret under the GCP project with the secretId.

Method Detail

createSecret

void createSecret(String secretId,
                  String payload)

Creates a new secret or a new version of existing secret with the provided payload.

If there is already a secret saved in SecretManager with the specified secretId, then it simply creates a new version under the secret with the secret payload.

Parameters:

secretId - the secret ID of the secret to create.

payload - the secret payload string.

createSecret

void createSecret(String secretId,
                  byte[] payload)

Creates a new secret or a new version of existing secret with the provided payload.

If there is already a secret saved in SecretManager with the specified secretId, then it simply creates a new version under the secret with the secret payload.

Parameters:

secretId - the secret ID of the secret to create.

payload - the secret payload as a byte array.

getSecretString

String getSecretString(String secretId)

Gets the secret payload of the specified secretId at the latest version.

Parameters:

secretId - unique identifier of your secret in Secret Manager.

Returns:

The secret payload as String

getSecretString

String getSecretString(String secretId,
                       String versionName)

Gets the secret payload of the specified secretId at version versionName.

Parameters:

secretId - unique identifier of your secret in Secret Manager.

versionName - which version of the secret to load. The version can be a version number as a string (e.g. "5") or an alias (e.g. "latest").

Returns:

The secret payload as String

getSecretBytes

byte[] getSecretBytes(String secretId)

Gets the secret payload of the specified secretId at the latest version.

Parameters:

secretId - unique identifier of your secret in Secret Manager.

Returns:

The secret payload as byte[]

getSecretBytes

byte[] getSecretBytes(String secretId,
                      String versionName)

Gets the secret payload of the specified secretId at version versionName.

Parameters:

secretId - unique identifier of your secret in Secret Manager.

versionName - which version of the secret to load. The version can be a version number as a string (e.g. "5") or an alias (e.g. "latest").

Returns:

The secret payload as byte[]

getSecretByteString

com.google.protobuf.ByteString getSecretByteString(String secretId,
                                                   String versionName)

Gets the secret payload of the specified secretId at version versionName.

Parameters:

secretId - unique identifier of your secret in Secret Manager.

versionName - which version of the secret to load. The version can be a version number as a string (e.g. "5") or an alias (e.g. "latest").

Returns:

The secret payload as ByteString

secretExists

boolean secretExists(String secretId)

Returns true if there already exists a secret under the GCP project with the secretId.

Parameters:

secretId - unique identifier of your secret in Secret Manager.

Returns:

true if the secret exists in Secret Manager; false otherwise