Package com.google.cloud.functions.v1

Class SecretVolume

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.functions.v1.SecretVolume
All Implemented Interfaces:
SecretVolumeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SecretVolume extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SecretVolume.Builder
    Configuration for a secret volume.
    static final class 
    SecretVolume.SecretVersion
    Configuration for a single version.
    static interface 
    SecretVolume.SecretVersionOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    MOUNT_PATH_FIELD_NUMBER
     
    static final int
    PROJECT_ID_FIELD_NUMBER
     
    static final int
    SECRET_FIELD_NUMBER
     
    static final int
    VERSIONS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static SecretVolume
    getDefaultInstance()
     
    SecretVolume
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getMountPath()
    The path within the container to mount the secret volume.
    com.google.protobuf.ByteString
    getMountPathBytes()
    The path within the container to mount the secret volume.
    com.google.protobuf.Parser<SecretVolume>
    getParserForType()
     
    String
    getProjectId()
    Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret.
    com.google.protobuf.ByteString
    getProjectIdBytes()
    Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret.
    String
    getSecret()
    Name of the secret in secret manager (not the full resource name).
    com.google.protobuf.ByteString
    getSecretBytes()
    Name of the secret in secret manager (not the full resource name).
    int
    getSerializedSize()
     
    SecretVolume.SecretVersion
    getVersions(int index)
    List of secret versions to mount for this secret.
    int
    getVersionsCount()
    List of secret versions to mount for this secret.
    List<SecretVolume.SecretVersion>
    getVersionsList()
    List of secret versions to mount for this secret.
    SecretVolume.SecretVersionOrBuilder
    getVersionsOrBuilder(int index)
    List of secret versions to mount for this secret.
    List<? extends SecretVolume.SecretVersionOrBuilder>
    getVersionsOrBuilderList()
    List of secret versions to mount for this secret.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SecretVolume.Builder
    newBuilder()
     
    static SecretVolume.Builder
    newBuilder(SecretVolume prototype)
     
    SecretVolume.Builder
    newBuilderForType()
     
    protected SecretVolume.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static SecretVolume
    parseDelimitedFrom(InputStream input)
     
    static SecretVolume
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SecretVolume
    parseFrom(byte[] data)
     
    static SecretVolume
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SecretVolume
    parseFrom(com.google.protobuf.ByteString data)
     
    static SecretVolume
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SecretVolume
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SecretVolume
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SecretVolume
    parseFrom(InputStream input)
     
    static SecretVolume
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SecretVolume
    parseFrom(ByteBuffer data)
     
    static SecretVolume
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SecretVolume>
    parser()
     
    SecretVolume.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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;
      Specified by:
      getMountPath in interface SecretVolumeOrBuilder
      Returns:
      The mountPath.

    • getMountPathBytes

      public com.google.protobuf.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;
      Specified by:
      getMountPathBytes in interface SecretVolumeOrBuilder
      Returns:
      The bytes for mountPath.

    • 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;
      Specified by:
      getProjectId in interface SecretVolumeOrBuilder
      Returns:
      The projectId.

    • getProjectIdBytes

      public com.google.protobuf.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;
      Specified by:
      getProjectIdBytes in interface SecretVolumeOrBuilder
      Returns:
      The bytes for projectId.

    • getSecret

      public String getSecret()
       Name of the secret in secret manager (not the full resource name).
      string secret = 3;
      Specified by:
      getSecret in interface SecretVolumeOrBuilder
      Returns:
      The secret.

    • getSecretBytes

      public com.google.protobuf.ByteString getSecretBytes()
       Name of the secret in secret manager (not the full resource name).
      string secret = 3;
      Specified by:
      getSecretBytes in interface SecretVolumeOrBuilder
      Returns:
      The bytes for secret.

    • 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;
      Specified by:
      getVersionsList in interface SecretVolumeOrBuilder

    • 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;
      Specified by:
      getVersionsOrBuilderList in interface SecretVolumeOrBuilder

    • 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;
      Specified by:
      getVersionsCount in interface SecretVolumeOrBuilder

    • getVersions

      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;
      Specified by:
      getVersions in interface SecretVolumeOrBuilder

    • getVersionsOrBuilder

      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;
      Specified by:
      getVersionsOrBuilder in interface SecretVolumeOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SecretVolume parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SecretVolume parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SecretVolume parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SecretVolume parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SecretVolume parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SecretVolume parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SecretVolume parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SecretVolume parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SecretVolume parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SecretVolume parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SecretVolume parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SecretVolume parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SecretVolume.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SecretVolume.Builder newBuilder()

    • newBuilder

      public static SecretVolume.Builder newBuilder(SecretVolume prototype)

    • toBuilder

      public SecretVolume.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SecretVolume.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SecretVolume getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SecretVolume> parser()

    • getParserForType

      public com.google.protobuf.Parser<SecretVolume> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SecretVolume getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder