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 message google.cloud.run.v2.SecretVolumeSource
Namespace
Google \ Cloud \ Run \ V2Methods
__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. |
↳ items |
array<VersionToPath>
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setItems
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<VersionToPath>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefaultMode
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|