Class SecretVolume (2.15.0)

publicfinalclass SecretVolumeextendsGeneratedMessageV3implementsSecretVolumeOrBuilder

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.v2beta.SecretVolume

Inherited Members

Static Fields

MOUNT_PATH_FIELD_NUMBER

publicstaticfinalintMOUNT_PATH_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

publicstaticfinalintPROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

SECRET_FIELD_NUMBER

publicstaticfinalintSECRET_FIELD_NUMBER
Field Value
Type Description
int

VERSIONS_FIELD_NUMBER

publicstaticfinalintVERSIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticSecretVolumegetDefaultInstance()
Returns
Type Description
SecretVolume

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticSecretVolume.BuildernewBuilder()
Returns
Type Description
SecretVolume.Builder

newBuilder(SecretVolume prototype)

publicstaticSecretVolume.BuildernewBuilder(SecretVolumeprototype)
Parameter
Name Description
prototype SecretVolume
Returns
Type Description
SecretVolume.Builder

parseDelimitedFrom(InputStream input)

publicstaticSecretVolumeparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
SecretVolume
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticSecretVolumeparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretVolume
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticSecretVolumeparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
SecretVolume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticSecretVolumeparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretVolume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticSecretVolumeparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
SecretVolume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticSecretVolumeparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretVolume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticSecretVolumeparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SecretVolume
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticSecretVolumeparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretVolume
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticSecretVolumeparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
SecretVolume
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticSecretVolumeparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretVolume
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticSecretVolumeparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SecretVolume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticSecretVolumeparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretVolume
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<SecretVolume>parser()
Returns
Type Description
Parser<SecretVolume>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

publicSecretVolumegetDefaultInstanceForType()
Returns
Type Description
SecretVolume

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.

getParserForType()

publicParser<SecretVolume>getParserForType()
Returns
Type Description
Parser<SecretVolume>
Overrides

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.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

publicfinalUnknownFieldSetgetUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

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.v2beta.SecretVolume.SecretVersion versions = 4;

Parameter
Name Description
index int
Returns
Type Description
SecretVolume.SecretVersion

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.v2beta.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.v2beta.SecretVolume.SecretVersion versions = 4;

Returns
Type Description
List<SecretVersion>

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.v2beta.SecretVolume.SecretVersion versions = 4;

Parameter
Name Description
index int
Returns
Type Description
SecretVolume.SecretVersionOrBuilder

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.v2beta.SecretVolume.SecretVersion versions = 4;

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

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicSecretVolume.BuildernewBuilderForType()
Returns
Type Description
SecretVolume.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedSecretVolume.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SecretVolume.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicSecretVolume.BuildertoBuilder()
Returns
Type Description
SecretVolume.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

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.