Class InlineSecret (3.18.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
TypeDescription
int

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static InlineSecret getDefaultInstance()
Returns
TypeDescription
InlineSecret

getDescriptor()

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

newBuilder()

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

newBuilder(InlineSecret prototype)

public static InlineSecret.Builder newBuilder(InlineSecret prototype)
Parameter
NameDescription
prototypeInlineSecret
Returns
TypeDescription
InlineSecret.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

equals(Object obj)

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

getDefaultInstanceForType()

public InlineSecret getDefaultInstanceForType()
Returns
TypeDescription
InlineSecret

getEnvMap()

public Map<String,ByteString> getEnvMap()

Use #getEnvMapMap() instead.

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

The bytes for kmsKeyName.

getParserForType()

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

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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