Cloud Functions V2 API - Class Google::Cloud::Functions::V2::SecretEnvVar (v0.10.0)

Reference documentation and code samples for the Cloud Functions V2 API class Google::Cloud::Functions::V2::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#key

def key() -> ::String
Returns
  • (::String) — Name of the environment variable.

#key=

def key=(value) -> ::String
Parameter
  • value (::String) — Name of the environment variable.
Returns
  • (::String) — Name of the environment variable.

#project_id

def project_id() -> ::String
Returns
  • (::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.

#project_id=

def project_id=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def secret() -> ::String
Returns
  • (::String) — Name of the secret in secret manager (not the full resource name).

#secret=

def secret=(value) -> ::String
Parameter
  • value (::String) — Name of the secret in secret manager (not the full resource name).
Returns
  • (::String) — Name of the secret in secret manager (not the full resource name).

#version

def version() -> ::String
Returns
  • (::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.

#version=

def version=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.