Reference documentation and code samples for the Google Cloud Functions V2 Client class SecretVolume.
Configuration for a secret volume. It has the information necessary to fetch
the secret value from secret manager and make it available as files mounted
at the requested paths within the application container.
Generated from protobuf message google.cloud.functions.v2.SecretVolume
Namespace
Google \ Cloud \ Functions \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ mount_path
string
The path within the container to mount the secret volume. For example, setting the mount_path as /etc/secrets would mount the secret value files under the /etc/secrets directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount path: /etc/secrets
↳ 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).
List of secret versions to mount for this secret. If empty, the latest version of the secret will be made available in a file named after the secret under the mount point.
getMountPath
The path within the container to mount the secret volume. For example,
setting the mount_path as /etc/secrets would mount the secret value files
under the /etc/secrets directory. This directory will also be completely
shadowed and unavailable to mount any other secrets.
Recommended mount path: /etc/secrets
Returns
Type
Description
string
setMountPath
The path within the container to mount the secret volume. For example,
setting the mount_path as /etc/secrets would mount the secret value files
under the /etc/secrets directory. This directory will also be completely
shadowed and unavailable to mount any other secrets.
Recommended mount path: /etc/secrets
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
getVersions
List of secret versions to mount for this secret. If empty, the latest
version of the secret will be made available in a file named after the
secret under the mount point.
List of secret versions to mount for this secret. If empty, the latest
version of the secret will be made available in a file named after the
secret under the mount point.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Functions V2 Client - Class SecretVolume (2.0.6)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.6 (latest)](/php/docs/reference/cloud-functions/latest/V2.SecretVolume)\n- [2.0.5](/php/docs/reference/cloud-functions/2.0.5/V2.SecretVolume)\n- [1.7.0](/php/docs/reference/cloud-functions/1.7.0/V2.SecretVolume)\n- [1.6.5](/php/docs/reference/cloud-functions/1.6.5/V2.SecretVolume)\n- [1.5.0](/php/docs/reference/cloud-functions/1.5.0/V2.SecretVolume)\n- [1.4.2](/php/docs/reference/cloud-functions/1.4.2/V2.SecretVolume)\n- [1.3.1](/php/docs/reference/cloud-functions/1.3.1/V2.SecretVolume)\n- [1.2.0](/php/docs/reference/cloud-functions/1.2.0/V2.SecretVolume)\n- [1.1.2](/php/docs/reference/cloud-functions/1.1.2/V2.SecretVolume)\n- [1.0.3](/php/docs/reference/cloud-functions/1.0.3/V2.SecretVolume) \nReference documentation and code samples for the Google Cloud Functions V2 Client class SecretVolume.\n\nConfiguration for a secret volume. It has the information necessary to fetch\nthe secret value from secret manager and make it available as files mounted\nat the requested paths within the application container.\n\nGenerated from protobuf message `google.cloud.functions.v2.SecretVolume`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Functions \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMountPath\n\nThe path within the container to mount the secret volume. For example,\nsetting the mount_path as `/etc/secrets` would mount the secret value files\nunder the `/etc/secrets` directory. This directory will also be completely\nshadowed and unavailable to mount any other secrets.\n\nRecommended mount path: /etc/secrets\n\n### setMountPath\n\nThe path within the container to mount the secret volume. For example,\nsetting the mount_path as `/etc/secrets` would mount the secret value files\nunder the `/etc/secrets` directory. This directory will also be completely\nshadowed and unavailable to mount any other secrets.\n\nRecommended mount path: /etc/secrets\n\n### getProjectId\n\nProject identifier (preferably project number but can also be the project\nID) 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 project\nID) 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### getVersions\n\nList of secret versions to mount for this secret. If empty, the `latest`\nversion of the secret will be made available in a file named after the\nsecret under the mount point.\n\n### setVersions\n\nList of secret versions to mount for this secret. If empty, the `latest`\nversion of the secret will be made available in a file named after the\nsecret under the mount point."]]
