Reference documentation and code samples for the Google Cloud Run V2 Client class SecretVolumeSource.
The secret's value will be presented as the content of a file whose
name is defined in the item path. If no items are defined, the name of
the file is the secret.
Generated from protobuf messagegoogle.cloud.run.v2.SecretVolumeSource
Namespace
Google \ Cloud \ Run \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ secret
string
Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
↳ default_mode
int
Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * * Internally, a umask of 0222 will be applied to any non-zero value. * * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.
getSecret
Required. The name of the secret in Cloud Secret Manager.
Format: {secret} if the secret is in the same project.
projects/{project}/secrets/{secret} if the secret is
in a different project.
Returns
Type
Description
string
setSecret
Required. The name of the secret in Cloud Secret Manager.
Format: {secret} if the secret is in the same project.
projects/{project}/secrets/{secret} if the secret is
in a different project.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getItems
If unspecified, the volume will expose a file whose name is the
secret, relative to VolumeMount.mount_path.
If specified, the key will be used as the version to fetch from Cloud
Secret Manager and the path will be the name of the file exposed in the
volume. When items are defined, they must specify a path and a version.
If unspecified, the volume will expose a file whose name is the
secret, relative to VolumeMount.mount_path.
If specified, the key will be used as the version to fetch from Cloud
Secret Manager and the path will be the name of the file exposed in the
volume. When items are defined, they must specify a path and a version.
Integer representation of mode bits to use on created files by default.
Must be a value between 0000 and 0777 (octal), defaulting to 0444.
Directories within the path are not affected by this setting.
Notes
Internally, a umask of 0222 will be applied to any non-zero value.
This is an integer representation of the mode bits. So, the octal
integer value should look exactly as the chmod numeric notation with a
leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal)
or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or
493 (base-10).
This might be in conflict with other options that affect the
file mode, like fsGroup, and the result can be other mode bits set.
This might be in conflict with other options that affect the
file mode, like fsGroup, and as a result, other mode bits could be set.
Returns
Type
Description
int
setDefaultMode
Integer representation of mode bits to use on created files by default.
Must be a value between 0000 and 0777 (octal), defaulting to 0444.
Directories within the path are not affected by this setting.
Notes
Internally, a umask of 0222 will be applied to any non-zero value.
This is an integer representation of the mode bits. So, the octal
integer value should look exactly as the chmod numeric notation with a
leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal)
or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or
493 (base-10).
This might be in conflict with other options that affect the
file mode, like fsGroup, and the result can be other mode bits set.
This might be in conflict with other options that affect the
file mode, like fsGroup, and as a result, other mode bits could be set.
[[["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 Run V2 Client - Class SecretVolumeSource (1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/php/docs/reference/cloud-run/latest/V2.SecretVolumeSource)\n- [1.8.0](/php/docs/reference/cloud-run/1.8.0/V2.SecretVolumeSource)\n- [1.7.0](/php/docs/reference/cloud-run/1.7.0/V2.SecretVolumeSource)\n- [1.6.0](/php/docs/reference/cloud-run/1.6.0/V2.SecretVolumeSource)\n- [1.5.2](/php/docs/reference/cloud-run/1.5.2/V2.SecretVolumeSource)\n- [1.4.0](/php/docs/reference/cloud-run/1.4.0/V2.SecretVolumeSource)\n- [1.3.0](/php/docs/reference/cloud-run/1.3.0/V2.SecretVolumeSource)\n- [1.2.0](/php/docs/reference/cloud-run/1.2.0/V2.SecretVolumeSource)\n- [1.1.0](/php/docs/reference/cloud-run/1.1.0/V2.SecretVolumeSource)\n- [1.0.0](/php/docs/reference/cloud-run/1.0.0/V2.SecretVolumeSource)\n- [0.9.3](/php/docs/reference/cloud-run/0.9.3/V2.SecretVolumeSource)\n- [0.8.0](/php/docs/reference/cloud-run/0.8.0/V2.SecretVolumeSource)\n- [0.7.2](/php/docs/reference/cloud-run/0.7.2/V2.SecretVolumeSource)\n- [0.6.0](/php/docs/reference/cloud-run/0.6.0/V2.SecretVolumeSource)\n- [0.5.2](/php/docs/reference/cloud-run/0.5.2/V2.SecretVolumeSource)\n- [0.4.0](/php/docs/reference/cloud-run/0.4.0/V2.SecretVolumeSource)\n- [0.3.4](/php/docs/reference/cloud-run/0.3.4/V2.SecretVolumeSource) \nReference documentation and code samples for the Google Cloud Run V2 Client class SecretVolumeSource.\n\nThe secret's value will be presented as the content of a file whose\nname is defined in the item path. If no items are defined, the name of\nthe file is the secret.\n\nGenerated from protobuf message `google.cloud.run.v2.SecretVolumeSource`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Run \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSecret\n\nRequired. The name of the secret in Cloud Secret Manager.\n\nFormat: {secret} if the secret is in the same project.\nprojects/{project}/secrets/{secret} if the secret is\nin a different project.\n\n### setSecret\n\nRequired. The name of the secret in Cloud Secret Manager.\n\nFormat: {secret} if the secret is in the same project.\nprojects/{project}/secrets/{secret} if the secret is\nin a different project.\n\n### getItems\n\nIf unspecified, the volume will expose a file whose name is the\nsecret, relative to VolumeMount.mount_path.\n\nIf specified, the key will be used as the version to fetch from Cloud\nSecret Manager and the path will be the name of the file exposed in the\nvolume. When items are defined, they must specify a path and a version.\n\n### setItems\n\nIf unspecified, the volume will expose a file whose name is the\nsecret, relative to VolumeMount.mount_path.\n\nIf specified, the key will be used as the version to fetch from Cloud\nSecret Manager and the path will be the name of the file exposed in the\nvolume. When items are defined, they must specify a path and a version.\n\n### getDefaultMode\n\nInteger representation of mode bits to use on created files by default.\n\nMust be a value between 0000 and 0777 (octal), defaulting to 0444.\nDirectories within the path are not affected by this setting.\nNotes\n\n- Internally, a umask of 0222 will be applied to any non-zero value.\n- This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10).\n- This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.\n\n### setDefaultMode\n\nInteger representation of mode bits to use on created files by default.\n\nMust be a value between 0000 and 0777 (octal), defaulting to 0444.\nDirectories within the path are not affected by this setting.\nNotes\n\n- Internally, a umask of 0222 will be applied to any non-zero value.\n- This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10).\n- This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set."]]
