Google Cloud Functions V2 Client - Class SecretVolume (1.5.0)

Version 1.5.0

• 2.0.1 (latest)
• 2.0.0
• 1.7.0
• 1.6.5
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.0
• 1.1.2
• 1.0.3

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).
↳ versions	array<Google\Cloud\Functions\V2\SecretVolume\SecretVersion> 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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setVersions

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.

Parameter
Name	Description
var	array<Google\Cloud\Functions\V2\SecretVolume\SecretVersion>

Returns
Type	Description
$this