Reference documentation and code samples for the Google Cloud Functions V2 Client class SecretEnvVar.
Configuration for a secret environment variable. It has the information
necessary to fetch the secret value from secret manager and expose it as an
environment variable.
Generated from protobuf messagegoogle.cloud.functions.v2.SecretEnvVar
Namespace
Google \ Cloud \ Functions \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ key
string
Name of the environment variable.
↳ project_id
string
Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.
↳ secret
string
Name of the secret in secret manager (not the full resource name).
↳ version
string
Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.
getKey
Name of the environment variable.
Returns
Type
Description
string
setKey
Name of the environment variable.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getProjectId
Project identifier (preferably project number but can also be the
project ID) of the project that contains the secret. If not set, it is
assumed that the secret is in the same project as the function.
Returns
Type
Description
string
setProjectId
Project identifier (preferably project number but can also be the
project ID) of the project that contains the secret. If not set, it is
assumed that the secret is in the same project as the function.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSecret
Name of the secret in secret manager (not the full resource name).
Returns
Type
Description
string
setSecret
Name of the secret in secret manager (not the full resource name).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getVersion
Version of the secret (version number or the string 'latest'). It is
recommended to use a numeric version for secret environment variables as
any updates to the secret value is not reflected until new instances
start.
Returns
Type
Description
string
setVersion
Version of the secret (version number or the string 'latest'). It is
recommended to use a numeric version for secret environment variables as
any updates to the secret value is not reflected until new instances
start.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Functions V2 Client - Class SecretEnvVar (2.0.6)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.6 (latest)](/php/docs/reference/cloud-functions/latest/V2.SecretEnvVar)\n- [2.0.5](/php/docs/reference/cloud-functions/2.0.5/V2.SecretEnvVar)\n- [1.7.0](/php/docs/reference/cloud-functions/1.7.0/V2.SecretEnvVar)\n- [1.6.5](/php/docs/reference/cloud-functions/1.6.5/V2.SecretEnvVar)\n- [1.5.0](/php/docs/reference/cloud-functions/1.5.0/V2.SecretEnvVar)\n- [1.4.2](/php/docs/reference/cloud-functions/1.4.2/V2.SecretEnvVar)\n- [1.3.1](/php/docs/reference/cloud-functions/1.3.1/V2.SecretEnvVar)\n- [1.2.0](/php/docs/reference/cloud-functions/1.2.0/V2.SecretEnvVar)\n- [1.1.2](/php/docs/reference/cloud-functions/1.1.2/V2.SecretEnvVar)\n- [1.0.3](/php/docs/reference/cloud-functions/1.0.3/V2.SecretEnvVar) \nReference documentation and code samples for the Google Cloud Functions V2 Client class SecretEnvVar.\n\nConfiguration for a secret environment variable. It has the information\nnecessary to fetch the secret value from secret manager and expose it as an\nenvironment variable.\n\nGenerated from protobuf message `google.cloud.functions.v2.SecretEnvVar`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Functions \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getKey\n\nName of the environment variable.\n\n### setKey\n\nName of the environment variable.\n\n### getProjectId\n\nProject identifier (preferably project number but can also be the\nproject ID) of the project that contains the secret. If not set, it is\nassumed that the secret is in the same project as the function.\n\n### setProjectId\n\nProject identifier (preferably project number but can also be the\nproject ID) of the project that contains the secret. If not set, it is\nassumed that the secret is in the same project as the function.\n\n### getSecret\n\nName of the secret in secret manager (not the full resource name).\n\n### setSecret\n\nName of the secret in secret manager (not the full resource name).\n\n### getVersion\n\nVersion of the secret (version number or the string 'latest'). It is\nrecommended to use a numeric version for secret environment variables as\nany updates to the secret value is not reflected until new instances\nstart.\n\n### setVersion\n\nVersion of the secret (version number or the string 'latest'). It is\nrecommended to use a numeric version for secret environment variables as\nany updates to the secret value is not reflected until new instances\nstart."]]
