Class SecretVolume.Builder (2.13.0)

publicstaticfinalclass SecretVolume.BuilderextendsGeneratedMessageV3.Builder<SecretVolume.Builder>implementsSecretVolumeOrBuilder

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.

Protobuf type google.cloud.functions.v2alpha.SecretVolume

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
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

Methods

addAllVersions(Iterable<? extends SecretVolume.SecretVersion> values)

publicSecretVolume.BuilderaddAllVersions(Iterable<?extendsSecretVolume.SecretVersion>values)

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Parameter
Name Description
values Iterable<? extends com.google.cloud.functions.v2alpha.SecretVolume.SecretVersion>
Returns
Type Description

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicSecretVolume.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
value Object
Returns
Type Description
Overrides

addVersions(SecretVolume.SecretVersion value)

publicSecretVolume.BuilderaddVersions(SecretVolume.SecretVersionvalue)

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Parameter
Name Description
Returns
Type Description

addVersions(SecretVolume.SecretVersion.Builder builderForValue)

publicSecretVolume.BuilderaddVersions(SecretVolume.SecretVersion.BuilderbuilderForValue)

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Parameter
Name Description
Returns
Type Description

addVersions(int index, SecretVolume.SecretVersion value)

publicSecretVolume.BuilderaddVersions(intindex,SecretVolume.SecretVersionvalue)

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Parameters
Name Description
index int
Returns
Type Description

addVersions(int index, SecretVolume.SecretVersion.Builder builderForValue)

publicSecretVolume.BuilderaddVersions(intindex,SecretVolume.SecretVersion.BuilderbuilderForValue)

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Parameters
Name Description
index int
Returns
Type Description

addVersionsBuilder()

publicSecretVolume.SecretVersion.BuilderaddVersionsBuilder()

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Returns
Type Description

addVersionsBuilder(int index)

publicSecretVolume.SecretVersion.BuilderaddVersionsBuilder(intindex)

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Parameter
Name Description
index int
Returns
Type Description

build()

publicSecretVolumebuild()
Returns
Type Description

buildPartial()

publicSecretVolumebuildPartial()
Returns
Type Description

clear()

publicSecretVolume.Builderclear()
Returns
Type Description
Overrides

clearField(Descriptors.FieldDescriptor field)

publicSecretVolume.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
Returns
Type Description
Overrides

clearMountPath()

publicSecretVolume.BuilderclearMountPath()

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

string mount_path = 1;

Returns
Type Description
SecretVolume.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

publicSecretVolume.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
Returns
Type Description
Overrides

clearProjectId()

publicSecretVolume.BuilderclearProjectId()

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.

string project_id = 2;

Returns
Type Description
SecretVolume.Builder

This builder for chaining.

clearSecret()

publicSecretVolume.BuilderclearSecret()

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

string secret = 3;

Returns
Type Description
SecretVolume.Builder

This builder for chaining.

clearVersions()

publicSecretVolume.BuilderclearVersions()

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Returns
Type Description

clone()

publicSecretVolume.Builderclone()
Returns
Type Description
Overrides

getDefaultInstanceForType()

publicSecretVolumegetDefaultInstanceForType()
Returns
Type Description

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Overrides

getMountPath()

publicStringgetMountPath()

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

string mount_path = 1;

Returns
Type Description
String

The mountPath.

getMountPathBytes()

publicByteStringgetMountPathBytes()

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

string mount_path = 1;

Returns
Type Description
ByteString

The bytes for mountPath.

getProjectId()

publicStringgetProjectId()

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.

string project_id = 2;

Returns
Type Description
String

The projectId.

getProjectIdBytes()

publicByteStringgetProjectIdBytes()

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.

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.

getVersions(int index)

publicSecretVolume.SecretVersiongetVersions(intindex)

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Parameter
Name Description
index int
Returns
Type Description

getVersionsBuilder(int index)

publicSecretVolume.SecretVersion.BuildergetVersionsBuilder(intindex)

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Parameter
Name Description
index int
Returns
Type Description

getVersionsBuilderList()

publicList<SecretVolume.SecretVersion.Builder>getVersionsBuilderList()

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Returns
Type Description

getVersionsCount()

publicintgetVersionsCount()

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Returns
Type Description
int

getVersionsList()

publicList<SecretVolume.SecretVersion>getVersionsList()

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Returns
Type Description

getVersionsOrBuilder(int index)

publicSecretVolume.SecretVersionOrBuildergetVersionsOrBuilder(intindex)

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Parameter
Name Description
index int
Returns
Type Description

getVersionsOrBuilderList()

publicList<?extendsSecretVolume.SecretVersionOrBuilder>getVersionsOrBuilderList()

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Returns
Type Description
List<? extends com.google.cloud.functions.v2alpha.SecretVolume.SecretVersionOrBuilder>

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
Overrides

mergeFrom(SecretVolume other)

publicSecretVolume.BuildermergeFrom(SecretVolumeother)
Parameter
Name Description
other SecretVolume
Returns
Type Description

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicSecretVolume.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Overrides Exceptions
Type Description

mergeFrom(Message other)

publicSecretVolume.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalSecretVolume.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overrides

removeVersions(int index)

publicSecretVolume.BuilderremoveVersions(intindex)

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Parameter
Name Description
index int
Returns
Type Description

setField(Descriptors.FieldDescriptor field, Object value)

publicSecretVolume.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
value Object
Returns
Type Description
Overrides

setMountPath(String value)

publicSecretVolume.BuildersetMountPath(Stringvalue)

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

string mount_path = 1;

Parameter
Name Description
value String

The mountPath to set.

Returns
Type Description
SecretVolume.Builder

This builder for chaining.

setMountPathBytes(ByteString value)

publicSecretVolume.BuildersetMountPathBytes(ByteStringvalue)

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

string mount_path = 1;

Parameter
Name Description
value ByteString

The bytes for mountPath to set.

Returns
Type Description
SecretVolume.Builder

This builder for chaining.

setProjectId(String value)

publicSecretVolume.BuildersetProjectId(Stringvalue)

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.

string project_id = 2;

Parameter
Name Description
value String

The projectId to set.

Returns
Type Description
SecretVolume.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

publicSecretVolume.BuildersetProjectIdBytes(ByteStringvalue)

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.

string project_id = 2;

Parameter
Name Description
value ByteString

The bytes for projectId to set.

Returns
Type Description
SecretVolume.Builder

This builder for chaining.

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

publicSecretVolume.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
index int
value Object
Returns
Type Description
Overrides

setSecret(String value)

publicSecretVolume.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
SecretVolume.Builder

This builder for chaining.

setSecretBytes(ByteString value)

publicSecretVolume.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
SecretVolume.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalSecretVolume.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overrides

setVersions(int index, SecretVolume.SecretVersion value)

publicSecretVolume.BuildersetVersions(intindex,SecretVolume.SecretVersionvalue)

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Parameters
Name Description
index int
Returns
Type Description

setVersions(int index, SecretVolume.SecretVersion.Builder builderForValue)

publicSecretVolume.BuildersetVersions(intindex,SecretVolume.SecretVersion.BuilderbuilderForValue)

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.

repeated .google.cloud.functions.v2alpha.SecretVolume.SecretVersion versions = 4;

Parameters
Name Description
index int
Returns
Type Description

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.