Send feedback
  
   
 
  
    
      Class SecretEnvVar (2.80.0) 
  
  
  
   
  
    
  
  
    
    
    
    
    
  Version latestkeyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  SecretEnvVar   extends   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.v2alpha.SecretEnvVar
    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
   
  KEY_FIELD_NUMBER 
  
    
public   static   final   int   KEY_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  
     
  
  VERSION_FIELD_NUMBER 
  
    
public   static   final   int   VERSION_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  getDefaultInstance() 
  
    
public   static   SecretEnvVar   getDefaultInstance ()  
  
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  newBuilder() 
  
    
public   static   SecretEnvVar . Builder   newBuilder ()  
  
  newBuilder(SecretEnvVar prototype) 
  
    
public   static   SecretEnvVar . Builder   newBuilder ( SecretEnvVar   prototype )  
  
  
  
    
public   static   SecretEnvVar   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
    
public   static   SecretEnvVar   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(byte[] data) 
  
    
public   static   SecretEnvVar   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   SecretEnvVar   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteString data) 
  
    
public   static   SecretEnvVar   parseFrom ( ByteString   data )  
  
  
  
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   SecretEnvVar   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   SecretEnvVar   parseFrom ( CodedInputStream   input )  
  
  
  
  
    
public   static   SecretEnvVar   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   SecretEnvVar   parseFrom ( InputStream   input )  
  
  
  
  
    
public   static   SecretEnvVar   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteBuffer data) 
  
    
public   static   SecretEnvVar   parseFrom ( ByteBuffer   data )  
  
  
  
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   SecretEnvVar   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parser() 
  
    
public   static   Parser<SecretEnvVar>   parser ()  
  
  Methods
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  getDefaultInstanceForType() 
  
    
public   SecretEnvVar   getDefaultInstanceForType ()  
  
  getKey() 
  
   Name of the environment variable.
 string key = 1;
    
      
        Returns  
      
        Type Description  
      
        String The key.
 
     
  
  getKeyBytes() 
  
    
public   ByteString   getKeyBytes ()  
   Name of the environment variable.
 string key = 1;
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for key.
 
     
  
  getParserForType() 
  
    
public   Parser<SecretEnvVar>   getParserForType ()  
  
  Overrides 
  
  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 ()  
   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() 
  
    
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 
  
  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;
    
      
        Returns  
      
        Type Description  
      
        String The version.
 
     
  
  getVersionBytes() 
  
    
public   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;
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for version.
 
     
  
  hashCode() 
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  newBuilderForType() 
  
    
public   SecretEnvVar . Builder   newBuilderForType ()  
  
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   SecretEnvVar . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  toBuilder() 
  
    
public   SecretEnvVar . Builder   toBuilder ()  
  
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
    
    
      
       
         
  
  
    
    Send feedback
  
   
 
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-29 UTC.
 
 
  
  
    
    
    
      
  
  
    Need to tell us more?
  
   
 
     
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]