Class SecretVolume.Builder (2.65.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
publicstaticfinalclass SecretVolume.BuilderextendsGeneratedMessageV3.Builder<SecretVolume.Builder>implementsSecretVolumeOrBuilderConfiguration 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.v2alpha.SecretVolume
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SecretVolume.BuilderImplements
SecretVolumeOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllVersions(Iterable<? extends SecretVolume.SecretVersion> values)
publicSecretVolume.BuilderaddAllVersions(Iterable<?extendsSecretVolume.SecretVersion>values) 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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.functions.v2alpha.SecretVolume.SecretVersion> |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicSecretVolume.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
addVersions(SecretVolume.SecretVersion value)
publicSecretVolume.BuilderaddVersions(SecretVolume.SecretVersionvalue) 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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
SecretVolume.SecretVersion |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
addVersions(SecretVolume.SecretVersion.Builder builderForValue)
publicSecretVolume.BuilderaddVersions(SecretVolume.SecretVersion.BuilderbuilderForValue) 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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SecretVolume.SecretVersion.Builder |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
addVersions(int index, SecretVolume.SecretVersion value)
publicSecretVolume.BuilderaddVersions(intindex,SecretVolume.SecretVersionvalue) 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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SecretVolume.SecretVersion |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
addVersions(int index, SecretVolume.SecretVersion.Builder builderForValue)
publicSecretVolume.BuilderaddVersions(intindex,SecretVolume.SecretVersion.BuilderbuilderForValue) 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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SecretVolume.SecretVersion.Builder |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
addVersionsBuilder()
publicSecretVolume.SecretVersion.BuilderaddVersionsBuilder() 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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Returns | |
|---|---|
| Type | Description |
SecretVolume.SecretVersion.Builder |
|
addVersionsBuilder(int index)
publicSecretVolume.SecretVersion.BuilderaddVersionsBuilder(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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.SecretVersion.Builder |
|
build()
publicSecretVolumebuild()| Returns | |
|---|---|
| Type | Description |
SecretVolume |
|
buildPartial()
publicSecretVolumebuildPartial()| Returns | |
|---|---|
| Type | Description |
SecretVolume |
|
clear()
publicSecretVolume.Builderclear()| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
clearField(Descriptors.FieldDescriptor field)
publicSecretVolume.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
clearMountPath()
publicSecretVolume.BuilderclearMountPath() 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 |
SecretVolume.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
publicSecretVolume.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
clearProjectId()
publicSecretVolume.BuilderclearProjectId()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 |
SecretVolume.Builder |
This builder for chaining. |
clearSecret()
publicSecretVolume.BuilderclearSecret()Name of the secret in secret manager (not the full resource name).
string secret = 3;
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
This builder for chaining. |
clearVersions()
publicSecretVolume.BuilderclearVersions() 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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
clone()
publicSecretVolume.Builderclone()| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
getDefaultInstanceForType()
publicSecretVolumegetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SecretVolume |
|
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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. |
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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.SecretVersion |
|
getVersionsBuilder(int index)
publicSecretVolume.SecretVersion.BuildergetVersionsBuilder(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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.SecretVersion.Builder |
|
getVersionsBuilderList()
publicList<SecretVolume.SecretVersion.Builder>getVersionsBuilderList() 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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.functions.v2alpha.SecretVolume.SecretVersionOrBuilder> |
|
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SecretVolume other)
publicSecretVolume.BuildermergeFrom(SecretVolumeother)| Parameter | |
|---|---|
| Name | Description |
other |
SecretVolume |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicSecretVolume.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicSecretVolume.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalSecretVolume.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
removeVersions(int index)
publicSecretVolume.BuilderremoveVersions(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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
publicSecretVolume.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
setMountPath(String value)
publicSecretVolume.BuildersetMountPath(Stringvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
String The mountPath to set. |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
This builder for chaining. |
setMountPathBytes(ByteString value)
publicSecretVolume.BuildersetMountPathBytes(ByteStringvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes for mountPath to set. |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
This builder for chaining. |
setProjectId(String value)
publicSecretVolume.BuildersetProjectId(Stringvalue)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;
| Parameter | |
|---|---|
| Name | Description |
value |
String The projectId to set. |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
This builder for chaining. |
setProjectIdBytes(ByteString value)
publicSecretVolume.BuildersetProjectIdBytes(ByteStringvalue)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes for projectId to set. |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicSecretVolume.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
setSecret(String value)
publicSecretVolume.BuildersetSecret(Stringvalue)Name of the secret in secret manager (not the full resource name).
string secret = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
String The secret to set. |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
This builder for chaining. |
setSecretBytes(ByteString value)
publicSecretVolume.BuildersetSecretBytes(ByteStringvalue)Name of the secret in secret manager (not the full resource name).
string secret = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes for secret to set. |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalSecretVolume.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
setVersions(int index, SecretVolume.SecretVersion value)
publicSecretVolume.BuildersetVersions(intindex,SecretVolume.SecretVersionvalue) 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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SecretVolume.SecretVersion |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|
setVersions(int index, SecretVolume.SecretVersion.Builder builderForValue)
publicSecretVolume.BuildersetVersions(intindex,SecretVolume.SecretVersion.BuilderbuilderForValue) 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.v2alpha.SecretVolume.SecretVersion versions = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SecretVolume.SecretVersion.Builder |
| Returns | |
|---|---|
| Type | Description |
SecretVolume.Builder |
|