Class SecretEnvVar (2.4.0)

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. Secret value is not a part of the configuration. Secret values are only fetched when a new clone starts.

Protobuf type google.cloud.functions.v1.SecretEnvVar

Static Fields

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

SECRET_FIELD_NUMBER

public static final int SECRET_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SecretEnvVar getDefaultInstance()
Returns
TypeDescription
SecretEnvVar

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SecretEnvVar.Builder newBuilder()
Returns
TypeDescription
SecretEnvVar.Builder

newBuilder(SecretEnvVar prototype)

public static SecretEnvVar.Builder newBuilder(SecretEnvVar prototype)
Parameter
NameDescription
prototypeSecretEnvVar
Returns
TypeDescription
SecretEnvVar.Builder

parseDelimitedFrom(InputStream input)

public static SecretEnvVar parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SecretEnvVar
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecretEnvVar parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecretEnvVar
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SecretEnvVar parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SecretEnvVar
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SecretEnvVar parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecretEnvVar
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SecretEnvVar parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SecretEnvVar
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SecretEnvVar parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecretEnvVar
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SecretEnvVar parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SecretEnvVar
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SecretEnvVar parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecretEnvVar
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SecretEnvVar parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SecretEnvVar
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecretEnvVar parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecretEnvVar
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SecretEnvVar parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SecretEnvVar
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SecretEnvVar parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecretEnvVar
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SecretEnvVar> parser()
Returns
TypeDescription
Parser<SecretEnvVar>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SecretEnvVar getDefaultInstanceForType()
Returns
TypeDescription
SecretEnvVar

getKey()

public String getKey()

Name of the environment variable.

string key = 1;

Returns
TypeDescription
String

The key.

getKeyBytes()

public ByteString getKeyBytes()

Name of the environment variable.

string key = 1;

Returns
TypeDescription
ByteString

The bytes for key.

getParserForType()

public Parser<SecretEnvVar> getParserForType()
Returns
TypeDescription
Parser<SecretEnvVar>
Overrides

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;

Returns
TypeDescription
String

The projectId.

getProjectIdBytes()

public 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;

Returns
TypeDescription
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
TypeDescription
String

The secret.

getSecretBytes()

public ByteString getSecretBytes()

Name of the secret in secret manager (not the full resource name).

string secret = 3;

Returns
TypeDescription
ByteString

The bytes for secret.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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 clones start.

string version = 4;

Returns
TypeDescription
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 clones start.

string version = 4;

Returns
TypeDescription
ByteString

The bytes for version.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SecretEnvVar.Builder newBuilderForType()
Returns
TypeDescription
SecretEnvVar.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SecretEnvVar.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SecretEnvVar.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SecretEnvVar.Builder toBuilder()
Returns
TypeDescription
SecretEnvVar.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException