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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SecretVolume.Builder newBuilder()
newBuilder(SecretVolume prototype)
public static SecretVolume.Builder newBuilder(SecretVolume prototype)
public static SecretVolume parseDelimitedFrom(InputStream input)
public static SecretVolume parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SecretVolume parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SecretVolume parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SecretVolume parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SecretVolume parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SecretVolume parseFrom(CodedInputStream input)
public static SecretVolume parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SecretVolume parseFrom(InputStream input)
public static SecretVolume parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SecretVolume parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SecretVolume parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SecretVolume> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public SecretVolume getDefaultInstanceForType()
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()
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
|
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;
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
|
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SecretVolume.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SecretVolume.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public SecretVolume.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
