Class SecretVolume (2.13.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.77.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.72.0
- 2.70.0
- 2.69.0
- 2.66.0
- 2.65.0
- 2.64.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.4
- 2.4.3
- 2.3.6
publicfinalclass SecretVolumeextendsGeneratedMessageV3implementsSecretVolumeOrBuilderConfiguration 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SecretVolumeImplements
SecretVolumeOrBuilderInherited Members
Static Fields
MOUNT_PATH_FIELD_NUMBER
publicstaticfinalintMOUNT_PATH_FIELD_NUMBERPROJECT_ID_FIELD_NUMBER
publicstaticfinalintPROJECT_ID_FIELD_NUMBERSECRET_FIELD_NUMBER
publicstaticfinalintSECRET_FIELD_NUMBERVERSIONS_FIELD_NUMBER
publicstaticfinalintVERSIONS_FIELD_NUMBERStatic Methods
getDefaultInstance()
publicstaticSecretVolumegetDefaultInstance()getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()newBuilder()
publicstaticSecretVolume.BuildernewBuilder()newBuilder(SecretVolume prototype)
publicstaticSecretVolume.BuildernewBuilder(SecretVolumeprototype)parseDelimitedFrom(InputStream input)
publicstaticSecretVolumeparseDelimitedFrom(InputStreaminput)parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticSecretVolumeparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(byte[] data)
publicstaticSecretVolumeparseFrom(byte[]data)data
byte[]parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticSecretVolumeparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)data
byte[]parseFrom(ByteString data)
publicstaticSecretVolumeparseFrom(ByteStringdata)parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticSecretVolumeparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)parseFrom(CodedInputStream input)
publicstaticSecretVolumeparseFrom(CodedInputStreaminput)parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticSecretVolumeparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(InputStream input)
publicstaticSecretVolumeparseFrom(InputStreaminput)parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticSecretVolumeparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(ByteBuffer data)
publicstaticSecretVolumeparseFrom(ByteBufferdata)parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticSecretVolumeparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)parser()
publicstaticParser<SecretVolume>parser()Methods
equals(Object obj)
publicbooleanequals(Objectobj)getDefaultInstanceForType()
publicSecretVolumegetDefaultInstanceForType()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 paths: /etc/secrets
Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log
string mount_path = 1;
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 paths: /etc/secrets
Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log
string mount_path = 1;
ByteString
The bytes for mountPath.
getParserForType()
publicParser<SecretVolume>getParserForType()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 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;
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 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;
ByteString
The bytes for projectId.
getSecret()
publicStringgetSecret()Name of the secret in secret manager (not the full resource name).
string secret = 3;
String
The secret.
getSecretBytes()
publicByteStringgetSecretBytes()Name of the secret in secret manager (not the full resource name).
string secret = 3;
ByteString
The bytes for secret.
getSerializedSize()
publicintgetSerializedSize()getUnknownFields()
publicfinalUnknownFieldSetgetUnknownFields()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.v1.SecretVolume.SecretVersion versions = 4;
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.v1.SecretVolume.SecretVersion versions = 4;
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.v1.SecretVolume.SecretVersion versions = 4;
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.v1.SecretVolume.SecretVersion versions = 4;
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.v1.SecretVolume.SecretVersion versions = 4;
List<? extends com.google.cloud.functions.v1.SecretVolume.SecretVersionOrBuilder>
hashCode()
publicinthashCode()internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()isInitialized()
publicfinalbooleanisInitialized()newBuilderForType()
publicSecretVolume.BuildernewBuilderForType()newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedSecretVolume.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)toBuilder()
publicSecretVolume.BuildertoBuilder()writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)