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 message google.cloud.functions.v2.SecretEnvVar
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |