Package com.google.cloud.functions.v2

Class SecretEnvVar

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

  • Nested Class Summary

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

    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
    KEY_FIELD_NUMBER
     
    static final int
    PROJECT_ID_FIELD_NUMBER
     
    static final int
    SECRET_FIELD_NUMBER
     
    static final int
    VERSION_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 SecretEnvVar
    getDefaultInstance()
     
    SecretEnvVar
    getDefaultInstanceForType()
     
    static final 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 (preferably project number but can also be the project ID) of the project that contains the secret.
    com.google.protobuf.ByteString
    getProjectIdBytes()
    Project identifier (preferably 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.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SecretEnvVar.Builder
    newBuilder()
     
    static SecretEnvVar.Builder
    newBuilder(SecretEnvVar prototype)
     
    SecretEnvVar.Builder
    newBuilderForType()
     
    protected SecretEnvVar.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    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.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

    • getKey

      public String getKey()
       Name of the environment variable.
      string key = 1;
      Specified by:
      getKey in interface SecretEnvVarOrBuilder
      Returns:
      The key.

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

    • getProjectIdBytes

      public com.google.protobuf.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;
      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.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 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • 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

    • newBuilder

      public static SecretEnvVar.Builder newBuilder()

    • newBuilder

      public static SecretEnvVar.Builder newBuilder(SecretEnvVar prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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