Class SecretEnvVar (2.25.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.

Protobuf type google.cloud.functions.v1.SecretEnvVar

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SecretEnvVar

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()
Returns
Type Description
SecretEnvVar

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SecretEnvVar.Builder newBuilder()
Returns
Type Description
SecretEnvVar.Builder

newBuilder(SecretEnvVar prototype)

public static SecretEnvVar.Builder newBuilder(SecretEnvVar prototype)
Parameter
Name Description
prototype SecretEnvVar
Returns
Type Description
SecretEnvVar.Builder

parseDelimitedFrom(InputStream input)

public static SecretEnvVar parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecretEnvVar
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecretEnvVar parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretEnvVar
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SecretEnvVar parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SecretEnvVar
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SecretEnvVar parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretEnvVar
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SecretEnvVar parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SecretEnvVar
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SecretEnvVar parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretEnvVar
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SecretEnvVar parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SecretEnvVar
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SecretEnvVar parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretEnvVar
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SecretEnvVar parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecretEnvVar
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecretEnvVar parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretEnvVar
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SecretEnvVar parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SecretEnvVar
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SecretEnvVar parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretEnvVar
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SecretEnvVar> parser()
Returns
Type Description
Parser<SecretEnvVar>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SecretEnvVar getDefaultInstanceForType()
Returns
Type Description
SecretEnvVar

getKey()

public String 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()
Returns
Type Description
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 is populated with the function's project, assuming that the secret exists in the same project as the function.

string project_id = 2;

Returns
Type Description
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 is populated with the function's project, assuming that the secret exists 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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SecretEnvVar.Builder newBuilderForType()
Returns
Type Description
SecretEnvVar.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SecretEnvVar.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SecretEnvVar.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SecretEnvVar.Builder toBuilder()
Returns
Type Description
SecretEnvVar.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException