Class Secret (3.17.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
TypeDescription
int

SECRET_ENV_FIELD_NUMBER

public static final int SECRET_ENV_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Secret getDefaultInstance()
Returns
TypeDescription
Secret

getDescriptor()

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

newBuilder()

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

newBuilder(Secret prototype)

public static Secret.Builder newBuilder(Secret prototype)
Parameter
NameDescription
prototypeSecret
Returns
TypeDescription
Secret.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Secret> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public Secret getDefaultInstanceForType()
Returns
TypeDescription
Secret

getKmsKeyName()

public String getKmsKeyName()

Cloud KMS key name to use to decrypt these envs.

string kms_key_name = 1;

Returns
TypeDescription
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

Cloud KMS key name to use to decrypt these envs.

string kms_key_name = 1;

Returns
TypeDescription
ByteString

The bytes for kmsKeyName.

getParserForType()

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

getSecretEnv()

public Map<String,ByteString> getSecretEnv()

Use #getSecretEnvMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueByteString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
ByteString

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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