Package org.apache.beam.sdk.extensions.gcp.util

Class GcpSecret

java.lang.Object

org.apache.beam.sdk.util.Secret

org.apache.beam.sdk.extensions.gcp.util.GcpSecret

All Implemented Interfaces:

Serializable

public class GcpSecret
extends org.apache.beam.sdk.util.Secret

A Secret manager implementation that retrieves secrets from Google Cloud Secret Manager.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
GcpSecret(String versionName)	Initializes a GcpSecret object.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)
byte[]	getSecretBytes()	Returns the secret as a byte array.
String	getVersionName()	Returns the version name of the secret.
int	hashCode()

Methods inherited from class org.apache.beam.sdk.util.Secret

fromJson, fromJson, getBytes, getBytes, getString, getString, parseSecretOption

Methods inherited from class java.lang.Object

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

Constructor Details

GcpSecret

public GcpSecret(String versionName)

Initializes a GcpSecret object.

Parameters:

versionName - The full version name of the secret in Google Cloud Secret Manager. For example: projects//secrets//versions/1. For more info, see https://cloud.google.com/python/docs/reference/secretmanager/latest/google.cloud.secretmanager_v1beta1.services.secret_manager_service.SecretManagerServiceClient#google_cloud_secretmanager_v1beta1_services_secret_manager_service_SecretManagerServiceClient_access_secret_version

Method Details

getSecretBytes

public byte[] getSecretBytes()

Returns the secret as a byte array. Assumes that the current active service account has permissions to read the secret.

Specified by:

getSecretBytes in class org.apache.beam.sdk.util.Secret

Returns:

The secret as a byte array.

getVersionName

public String getVersionName()

Returns the version name of the secret.

Returns:

The version name as a String.

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object