Class InlineSecret (3.51.0)

public final class InlineSecret extends GeneratedMessageV3 implements InlineSecretOrBuilder

Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.

Protobuf type google.devtools.cloudbuild.v1.InlineSecret

Static Fields

ENV_MAP_FIELD_NUMBER

public static final int ENV_MAP_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static InlineSecret getDefaultInstance()
Returns
Type Description
InlineSecret

getDescriptor()

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

newBuilder()

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

newBuilder(InlineSecret prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsEnvMap(String key)

public boolean containsEnvMap(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> env_map = 2;

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

getEnvMap() (deprecated)

public Map<String,ByteString> getEnvMap()

Use #getEnvMapMap() instead.

Returns
Type Description
Map<String,ByteString>

getEnvMapCount()

public int getEnvMapCount()

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> env_map = 2;

Returns
Type Description
int

getEnvMapMap()

public Map<String,ByteString> getEnvMapMap()

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> env_map = 2;

Returns
Type Description
Map<String,ByteString>

getEnvMapOrDefault(String key, ByteString defaultValue)

public ByteString getEnvMapOrDefault(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> env_map = 2;

Parameters
Name Description
key String
defaultValue ByteString
Returns
Type Description
ByteString

getEnvMapOrThrow(String key)

public ByteString getEnvMapOrThrow(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> env_map = 2;

Parameter
Name Description
key String
Returns
Type Description
ByteString

getKmsKeyName()

public String getKmsKeyName()

Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/*

string kms_key_name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/*

string kms_key_name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for kmsKeyName.

getParserForType()

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

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 InlineSecret.Builder newBuilderForType()
Returns
Type Description
InlineSecret.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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