Google Cloud Functions V1 Client - Class SecretEnvVar (1.3.1)

Reference documentation and code samples for the Google Cloud Functions V1 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.v1.SecretEnvVar

Namespace

Google \ Cloud \ Functions \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ key string

Name of the environment variable.

↳ project_id string

Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it is populated with the function's project, assuming that the secret exists 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
TypeDescription
string

setKey

Name of the environment variable.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProjectId

Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it is populated with the function's project, assuming that the secret exists in the same project as the function.

Returns
TypeDescription
string

setProjectId

Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it is populated with the function's project, assuming that the secret exists in the same project as the function.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSecret

Name of the secret in Secret Manager (not the full resource name).

Returns
TypeDescription
string

setSecret

Name of the secret in Secret Manager (not the full resource name).

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this