Class: Google::Apis::CloudfunctionsV1::SecretEnvVar

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudfunctions_v1/classes.rb,
lib/google/apis/cloudfunctions_v1/representations.rb,
lib/google/apis/cloudfunctions_v1/representations.rb

Overview

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. Secret value is not a part of the configuration. Secret values are only fetched when a new clone starts.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SecretEnvVar

Returns a new instance of SecretEnvVar.



1134
1135
1136
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 1134

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#key ⇒ String

Name of the environment variable. Corresponds to the JSON property key

Returns:

  • (String) 


1112
1113
1114
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 1112

def key
  @key
end

#project_id ⇒ String

Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function. Corresponds to the JSON property projectId

Returns:

  • (String) 


1120
1121
1122
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 1120

def project_id
  @project_id
end

#secret ⇒ String

Name of the secret in secret manager (not the full resource name). Corresponds to the JSON property secret

Returns:

  • (String) 


1125
1126
1127
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 1125

def secret
  @secret
end

#version ⇒ 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 clones start. Corresponds to the JSON property version

Returns:

  • (String) 


1132
1133
1134
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 1132

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1139
1140
1141
1142
1143
1144
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 1139

def update!(**args)
  @key = args[:key] if args.key?(:key)
  @project_id = args[:project_id] if args.key?(:project_id)
  @secret = args[:secret] if args.key?(:secret)
  @version = args[:version] if args.key?(:version)
end