org.apache.beam.it.gcp.secretmanager

Class SecretManagerResourceManager

java.lang.Object

org.apache.beam.it.gcp.secretmanager.SecretManagerResourceManager

All Implemented Interfaces:

org.apache.beam.it.common.ResourceManager

public class SecretManagerResourceManager
extends java.lang.Object
implements org.apache.beam.it.common.ResourceManager

Default class for implementation of ResourceManager interface.

The class provides an interaction with the real GCP Secret Manager client, with operations related to management of Secrets in the SecretManager.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecretManagerResourceManager.Builder Builder for SecretManagerResourceManager.

Constructor Summary

Constructors

Constructor and Description
SecretManagerResourceManager(java.lang.String projectId, com.google.cloud.secretmanager.v1.SecretManagerServiceClient secretManagerServiceClient)

Method Summary

Modifier and Type	Method and Description
java.lang.String	accessSecret(java.lang.String secretVersion) Calls Secret Manager with a Secret Version and returns the secret value.
void	addSecretVersion(java.lang.String secretId, java.lang.String secretData) Creates a new SecretVersion containing secret data and attaches it to an existing Secret.
static SecretManagerResourceManager.Builder	builder(java.lang.String projectId, com.google.api.gax.core.CredentialsProvider credentialsProvider)
void	cleanupAll()
void	createSecret(java.lang.String secretId, java.lang.String secretData) Creates a Secret with given name on GCP Secret Manager.
void	deleteSecret(java.lang.String secretId) Deletes a Secret.
void	destroySecretVersion(java.lang.String secretVersion) Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.
void	disableSecretVersion(java.lang.String secretVersion) Disables a SecretVersion.
void	enableSecretVersion(java.lang.String secretVersion) Enables a SecretVersion.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretManagerResourceManager

public SecretManagerResourceManager(java.lang.String projectId,
                                    com.google.cloud.secretmanager.v1.SecretManagerServiceClient secretManagerServiceClient)

Method Detail

builder

public static SecretManagerResourceManager.Builder builder(java.lang.String projectId,
                                                           com.google.api.gax.core.CredentialsProvider credentialsProvider)

createSecret

public void createSecret(java.lang.String secretId,
                         java.lang.String secretData)

Creates a Secret with given name on GCP Secret Manager.

Parameters:

secretId - Secret ID of the secret to be created

secretData - Value of the secret to be added

addSecretVersion

public void addSecretVersion(java.lang.String secretId,
                             java.lang.String secretData)

Creates a new SecretVersion containing secret data and attaches it to an existing Secret.

Parameters:

secretId - Parent secret to which version will be added

secretData - Value of the secret to be added

accessSecret

public java.lang.String accessSecret(java.lang.String secretVersion)

Calls Secret Manager with a Secret Version and returns the secret value.

Parameters:

secretVersion - Secret Version of the form projects/{project}/secrets/{secret}/versions/{secret_version}

Returns:

the secret value in Secret Manager

enableSecretVersion

public void enableSecretVersion(java.lang.String secretVersion)

Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.

Parameters:

secretVersion - The resource name of the SecretVersion to destroy in the format of projects/{project}/secrets/{secret}/versions/{secret_version}

disableSecretVersion

public void disableSecretVersion(java.lang.String secretVersion)

Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.

Parameters:

secretVersion - The resource name of the SecretVersion to destroy in the format of projects/{project}/secrets/{secret}/versions/{secret_version}

destroySecretVersion

public void destroySecretVersion(java.lang.String secretVersion)

Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.

Parameters:

secretVersion - The resource name of the SecretVersion to destroy in the format of projects/{project}/secrets/{secret}/versions/{secret_version}

deleteSecret

public void deleteSecret(java.lang.String secretId)

Deletes a Secret.

Parameters:

secretId - The resource name of the SecretVersion to delete in the format of projects/{project}/secrets/{secret}/versions/{secret_version}

cleanupAll

public void cleanupAll()

Specified by:

cleanupAll in interface org.apache.beam.it.common.ResourceManager