Class SecretEnvVar.Builder (2.34.0)

publicstaticfinalclass SecretEnvVar.BuilderextendsGeneratedMessageV3.Builder<SecretEnvVar.Builder>implementsSecretEnvVarOrBuilder

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.

Protobuf type google.cloud.functions.v1.SecretEnvVar

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicSecretEnvVar.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecretEnvVar.Builder
Overrides

build()

publicSecretEnvVarbuild()
Returns
Type Description
SecretEnvVar

buildPartial()

publicSecretEnvVarbuildPartial()
Returns
Type Description
SecretEnvVar

clear()

publicSecretEnvVar.Builderclear()
Returns
Type Description
SecretEnvVar.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

publicSecretEnvVar.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SecretEnvVar.Builder
Overrides

clearKey()

publicSecretEnvVar.BuilderclearKey()

Name of the environment variable.

string key = 1;

Returns
Type Description
SecretEnvVar.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

publicSecretEnvVar.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SecretEnvVar.Builder
Overrides

clearProjectId()

publicSecretEnvVar.BuilderclearProjectId()

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

string project_id = 2;

Returns
Type Description
SecretEnvVar.Builder

This builder for chaining.

clearSecret()

publicSecretEnvVar.BuilderclearSecret()

Name of the secret in Secret Manager (not the full resource name).

string secret = 3;

Returns
Type Description
SecretEnvVar.Builder

This builder for chaining.

clearVersion()

publicSecretEnvVar.BuilderclearVersion()

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.

string version = 4;

Returns
Type Description
SecretEnvVar.Builder

This builder for chaining.

clone()

publicSecretEnvVar.Builderclone()
Returns
Type Description
SecretEnvVar.Builder
Overrides

getDefaultInstanceForType()

publicSecretEnvVargetDefaultInstanceForType()
Returns
Type Description
SecretEnvVar

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getKey()

publicStringgetKey()

Name of the environment variable.

string key = 1;

Returns
Type Description
String

The key.

getKeyBytes()

publicByteStringgetKeyBytes()

Name of the environment variable.

string key = 1;

Returns
Type Description
ByteString

The bytes for key.

getProjectId()

publicStringgetProjectId()

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

string project_id = 2;

Returns
Type Description
String

The projectId.

getProjectIdBytes()

publicByteStringgetProjectIdBytes()

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

string project_id = 2;

Returns
Type Description
ByteString

The bytes for projectId.

getSecret()

publicStringgetSecret()

Name of the secret in Secret Manager (not the full resource name).

string secret = 3;

Returns
Type Description
String

The secret.

getSecretBytes()

publicByteStringgetSecretBytes()

Name of the secret in Secret Manager (not the full resource name).

string secret = 3;

Returns
Type Description
ByteString

The bytes for secret.

getVersion()

publicStringgetVersion()

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.

string version = 4;

Returns
Type Description
String

The version.

getVersionBytes()

publicByteStringgetVersionBytes()

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.

string version = 4;

Returns
Type Description
ByteString

The bytes for version.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SecretEnvVar other)

publicSecretEnvVar.BuildermergeFrom(SecretEnvVarother)
Parameter
Name Description
other SecretEnvVar
Returns
Type Description
SecretEnvVar.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicSecretEnvVar.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretEnvVar.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

publicSecretEnvVar.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
SecretEnvVar.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalSecretEnvVar.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecretEnvVar.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

publicSecretEnvVar.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecretEnvVar.Builder
Overrides

setKey(String value)

publicSecretEnvVar.BuildersetKey(Stringvalue)

Name of the environment variable.

string key = 1;

Parameter
Name Description
value String

The key to set.

Returns
Type Description
SecretEnvVar.Builder

This builder for chaining.

setKeyBytes(ByteString value)

publicSecretEnvVar.BuildersetKeyBytes(ByteStringvalue)

Name of the environment variable.

string key = 1;

Parameter
Name Description
value ByteString

The bytes for key to set.

Returns
Type Description
SecretEnvVar.Builder

This builder for chaining.

setProjectId(String value)

publicSecretEnvVar.BuildersetProjectId(Stringvalue)

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

string project_id = 2;

Parameter
Name Description
value String

The projectId to set.

Returns
Type Description
SecretEnvVar.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

publicSecretEnvVar.BuildersetProjectIdBytes(ByteStringvalue)

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

string project_id = 2;

Parameter
Name Description
value ByteString

The bytes for projectId to set.

Returns
Type Description
SecretEnvVar.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

publicSecretEnvVar.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SecretEnvVar.Builder
Overrides

setSecret(String value)

publicSecretEnvVar.BuildersetSecret(Stringvalue)

Name of the secret in Secret Manager (not the full resource name).

string secret = 3;

Parameter
Name Description
value String

The secret to set.

Returns
Type Description
SecretEnvVar.Builder

This builder for chaining.

setSecretBytes(ByteString value)

publicSecretEnvVar.BuildersetSecretBytes(ByteStringvalue)

Name of the secret in Secret Manager (not the full resource name).

string secret = 3;

Parameter
Name Description
value ByteString

The bytes for secret to set.

Returns
Type Description
SecretEnvVar.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalSecretEnvVar.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecretEnvVar.Builder
Overrides

setVersion(String value)

publicSecretEnvVar.BuildersetVersion(Stringvalue)

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.

string version = 4;

Parameter
Name Description
value String

The version to set.

Returns
Type Description
SecretEnvVar.Builder

This builder for chaining.

setVersionBytes(ByteString value)

publicSecretEnvVar.BuildersetVersionBytes(ByteStringvalue)

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.

string version = 4;

Parameter
Name Description
value ByteString

The bytes for version to set.

Returns
Type Description
SecretEnvVar.Builder

This builder for chaining.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.