Package com.google.cloud.functions.v1

Class SecretEnvVar

  • All Implemented Interfaces:
    SecretEnvVarOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SecretEnvVar
extends com.google.protobuf.GeneratedMessageV3
implements SecretEnvVarOrBuilder
     Configuration for a secret environment variable. It has the information
 necessary to fetch the secret value from Secret Manager and expose it as an
 environment variable.
    Protobuf type google.cloud.functions.v1.SecretEnvVar
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SecretEnvVar.Builder
      Configuration for a secret environment variable.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int KEY_FIELD_NUMBER  
      static int PROJECT_ID_FIELD_NUMBER  
      static int SECRET_FIELD_NUMBER  
      static int VERSION_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static SecretEnvVar getDefaultInstance()  
      SecretEnvVar getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      String getKey()
      Name of the environment variable.
      com.google.protobuf.ByteString getKeyBytes()
      Name of the environment variable.
      com.google.protobuf.Parser<SecretEnvVar> 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()  
      String getVersion()
      Version of the secret (version number or the string 'latest').
      com.google.protobuf.ByteString getVersionBytes()
      Version of the secret (version number or the string 'latest').
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static SecretEnvVar.Builder newBuilder()  
      static SecretEnvVar.Builder newBuilder​(SecretEnvVar prototype)  
      SecretEnvVar.Builder newBuilderForType()  
      protected SecretEnvVar.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static SecretEnvVar parseDelimitedFrom​(InputStream input)  
      static SecretEnvVar parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SecretEnvVar parseFrom​(byte[] data)  
      static SecretEnvVar parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SecretEnvVar parseFrom​(com.google.protobuf.ByteString data)  
      static SecretEnvVar parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SecretEnvVar parseFrom​(com.google.protobuf.CodedInputStream input)  
      static SecretEnvVar parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SecretEnvVar parseFrom​(InputStream input)  
      static SecretEnvVar parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SecretEnvVar parseFrom​(ByteBuffer data)  
      static SecretEnvVar parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<SecretEnvVar> parser()  
      SecretEnvVar.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • 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

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getKeyBytes

        public com.google.protobuf.ByteString getKeyBytes()
         Name of the environment variable.
        string key = 1;
        Specified by:
        getKeyBytes in interface SecretEnvVarOrBuilder
        Returns:
        The bytes for key.

      • 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 is
 populated with the function's project, assuming that the secret exists in
 the same project as the function.
        string project_id = 2;
        Specified by:
        getProjectId in interface SecretEnvVarOrBuilder
        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 is
 populated with the function's project, assuming that the secret exists in
 the same project as the function.
        string project_id = 2;
        Specified by:
        getProjectIdBytes in interface SecretEnvVarOrBuilder
        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 SecretEnvVarOrBuilder
        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 SecretEnvVarOrBuilder
        Returns:
        The bytes for secret.

      • getVersion

        public String getVersion()
         Version of the secret (version number or the string 'latest'). It is
 recommended to use a numeric version for secret environment variables as
 any updates to the secret value is not reflected until new instances start.
        string version = 4;
        Specified by:
        getVersion in interface SecretEnvVarOrBuilder
        Returns:
        The version.

      • getVersionBytes

        public com.google.protobuf.ByteString getVersionBytes()
         Version of the secret (version number or the string 'latest'). It is
 recommended to use a numeric version for secret environment variables as
 any updates to the secret value is not reflected until new instances start.
        string version = 4;
        Specified by:
        getVersionBytes in interface SecretEnvVarOrBuilder
        Returns:
        The bytes for version.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 SecretEnvVar parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected SecretEnvVar.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static SecretEnvVar getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<SecretEnvVar> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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