EnvironmentSecret

classView source ↗

class EnvironmentSecret(environment_variable_name: str)

Bases: Secret

Categories: secret

Secrets class representing a secret obtained from an environment variable in the server.

Attributes: environment_variable_name (str): Name of the environment variable from which we will obtain the secret value.

Methods: to_dict() -> dict: Convert the EnvironmentSecret object to a dictionary. secret_value() -> str: Get the secret value.

Initialize the EnvironmentSecret object.

Parameters

parameter

environment_variable_namestr

Name of the environment variable from which we will obtain the secret value.

Properties

property

secret_valuestr

Get the secret value pointed at by the secret. To be used only during execution in the backend.

Returns: str: The secret value.

Methods

method

View source ↗

to_dict

def to_dict() -> dict

Convert the EnvironmentSecret object to a dictionary.

Returns:

dict: A dictionary representation of the EnvironmentSecret object.