Class Secret (3.45.0)

public final class Secret extends GeneratedMessageV3 implements SecretOrBuilder

Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use kmsKeyName with available_secrets instead of using kmsKeyName with secret. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.

Protobuf type google.devtools.cloudbuild.v1.Secret

Implements

SecretOrBuilder

Static Fields

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
Type Description
int

SECRET_ENV_FIELD_NUMBER

public static final int SECRET_ENV_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Secret getDefaultInstance()
Returns
Type Description
Secret

getDescriptor()

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

newBuilder()

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

newBuilder(Secret prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsSecretEnv(String key)

public boolean containsSecretEnv(String key)

Map of environment variable name to its encrypted value.

Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.

map<string, bytes> secret_env = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public Secret getDefaultInstanceForType()
Returns
Type Description
Secret

getKmsKeyName()

public String getKmsKeyName()

Cloud KMS key name to use to decrypt these envs.

string kms_key_name = 1;

Returns
Type Description
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

Cloud KMS key name to use to decrypt these envs.

string kms_key_name = 1;

Returns
Type Description
ByteString

The bytes for kmsKeyName.

getParserForType()

public Parser<Secret> getParserForType()
Returns
Type Description
Parser<Secret>
Overrides

getSecretEnv() (deprecated)

public Map<String,ByteString> getSecretEnv()

Use #getSecretEnvMap() instead.

Returns
Type Description
Map<String,ByteString>

getSecretEnvCount()

public int getSecretEnvCount()

Map of environment variable name to its encrypted value.

Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.

map<string, bytes> secret_env = 3;

Returns
Type Description
int

getSecretEnvMap()

public Map<String,ByteString> getSecretEnvMap()

Map of environment variable name to its encrypted value.

Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.

map<string, bytes> secret_env = 3;

Returns
Type Description
Map<String,ByteString>

getSecretEnvOrDefault(String key, ByteString defaultValue)

public ByteString getSecretEnvOrDefault(String key, ByteString defaultValue)

Map of environment variable name to its encrypted value.

Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.

map<string, bytes> secret_env = 3;

Parameters
Name Description
key String
defaultValue ByteString
Returns
Type Description
ByteString

getSecretEnvOrThrow(String key)

public ByteString getSecretEnvOrThrow(String key)

Map of environment variable name to its encrypted value.

Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.

map<string, bytes> secret_env = 3;

Parameter
Name Description
key String
Returns
Type Description
ByteString

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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