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
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
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()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticSecretVolume.BuildernewBuilder()
newBuilder(SecretVolume prototype)
publicstaticSecretVolume.BuildernewBuilder(SecretVolumeprototype)
publicstaticSecretVolumeparseDelimitedFrom(InputStreaminput)
publicstaticSecretVolumeparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticSecretVolumeparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticSecretVolumeparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticSecretVolumeparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticSecretVolumeparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticSecretVolumeparseFrom(CodedInputStreaminput)
publicstaticSecretVolumeparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticSecretVolumeparseFrom(InputStreaminput)
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)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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 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()
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()
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
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
|
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;
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
|
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()
| Returns |
| Type |
Description |
int |
Overrides
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicSecretVolume.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedSecretVolume.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicSecretVolume.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides