Class SecretVolume (2.4.3)

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.

Protobuf type google.cloud.functions.v2beta.SecretVolume

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SecretVolume

Implements

SecretVolumeOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

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

AbstractMessage.equals(Object other)

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 path: /etc/secrets

string mount_path = 1;

Returns

Type	Description
String	The mountPath.

getMountPathBytes()

public ByteString getMountPathBytes()

string mount_path = 1;

Returns

Type	Description
ByteString	The bytes for mountPath.

getParserForType()

public Parser<SecretVolume> getParserForType()

Returns

Type	Description
Parser<SecretVolume>

Overrides

GeneratedMessageV3.getParserForType()

getProjectId()

public String getProjectId()

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()

public ByteString getProjectIdBytes()

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

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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

Returns

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

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	`UnusedPrivateParameter`

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public SecretVolume.Builder toBuilder()

Returns

Type	Description
SecretVolume.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException