Class SecretVolume (2.47.0)

public final class SecretVolume extends GeneratedMessageV3 implements SecretVolumeOrBuilder

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. Secret value is not a part of the configuration. Every filesystem read operation performs a lookup in secret manager to retrieve the secret value.

Protobuf type google.cloud.functions.v1.SecretVolume

Static Fields

MOUNT_PATH_FIELD_NUMBER

public static final int MOUNT_PATH_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

SECRET_FIELD_NUMBER

public static final int SECRET_FIELD_NUMBER
Field Value
Type Description
int

VERSIONS_FIELD_NUMBER

public static final int VERSIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SecretVolume getDefaultInstance()
Returns
Type Description
SecretVolume

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SecretVolume.Builder newBuilder()
Returns
Type Description
SecretVolume.Builder

newBuilder(SecretVolume prototype)

public static SecretVolume.Builder newBuilder(SecretVolume prototype)
Parameter
Name Description
prototype SecretVolume
Returns
Type Description
SecretVolume.Builder

parseDelimitedFrom(InputStream input)

public static SecretVolume parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecretVolume
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecretVolume parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretVolume
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SecretVolume parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SecretVolume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SecretVolume parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretVolume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SecretVolume parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SecretVolume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SecretVolume parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretVolume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SecretVolume parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SecretVolume
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SecretVolume parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretVolume
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SecretVolume parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecretVolume
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecretVolume parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretVolume
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SecretVolume parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SecretVolume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SecretVolume parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretVolume
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SecretVolume> parser()
Returns
Type Description
Parser<SecretVolume>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SecretVolume getDefaultInstanceForType()
Returns
Type Description
SecretVolume

getMountPath()

public String getMountPath()

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 paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log

string mount_path = 1;

Returns
Type Description
String

The mountPath.

getMountPathBytes()

public ByteString getMountPathBytes()

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 paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log

string mount_path = 1;

Returns
Type Description
ByteString

The bytes for mountPath.

getParserForType()

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

getProjectId()

public String getProjectId()

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.

string project_id = 2;

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

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.

string project_id = 2;

Returns
Type Description
ByteString

The bytes for projectId.

getSecret()

public String getSecret()

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

string secret = 3;

Returns
Type Description
String

The secret.

getSecretBytes()

public ByteString getSecretBytes()

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

string secret = 3;

Returns
Type Description
ByteString

The bytes for secret.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getVersions(int index)

public SecretVolume.SecretVersion getVersions(int index)

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

Parameter
Name Description
index int
Returns
Type Description
SecretVolume.SecretVersion

getVersionsCount()

public int getVersionsCount()

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

Returns
Type Description
int

getVersionsList()

public List<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.v1.SecretVolume.SecretVersion versions = 4;

Returns
Type Description
List<SecretVersion>

getVersionsOrBuilder(int index)

public SecretVolume.SecretVersionOrBuilder getVersionsOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
SecretVolume.SecretVersionOrBuilder

getVersionsOrBuilderList()

public List<? extends SecretVolume.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.v1.SecretVolume.SecretVersion versions = 4;

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SecretVolume.Builder newBuilderForType()
Returns
Type Description
SecretVolume.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SecretVolume.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SecretVolume.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SecretVolume.Builder toBuilder()
Returns
Type Description
SecretVolume.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException