- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.51.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.6
- 3.4.1
- 3.3.12
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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SecretImplements
SecretOrBuilderStatic Fields
KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER| Type | Description |
| int |
SECRET_ENV_FIELD_NUMBER
public static final int SECRET_ENV_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static Secret getDefaultInstance()| Type | Description |
| Secret |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static Secret.Builder newBuilder()| Type | Description |
| Secret.Builder |
newBuilder(Secret prototype)
public static Secret.Builder newBuilder(Secret prototype)| Name | Description |
| prototype | Secret |
| Type | Description |
| Secret.Builder |
parseDelimitedFrom(InputStream input)
public static Secret parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| Secret |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Secret parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Secret |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static Secret parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| Secret |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Secret parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Secret |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Secret parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| Secret |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Secret parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Secret |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Secret parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| Secret |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Secret parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Secret |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static Secret parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| Secret |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Secret parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Secret |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static Secret parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| Secret |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Secret parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Secret |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<Secret> parser()| 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;
| Name | Description |
| key | String |
| Type | Description |
| boolean |
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getDefaultInstanceForType()
public Secret getDefaultInstanceForType()| Type | Description |
| Secret |
getKmsKeyName()
public String getKmsKeyName()Cloud KMS key name to use to decrypt these envs.
string kms_key_name = 1;
| Type | Description |
| String | The kmsKeyName. |
getKmsKeyNameBytes()
public ByteString getKmsKeyNameBytes()Cloud KMS key name to use to decrypt these envs.
string kms_key_name = 1;
| Type | Description |
| ByteString | The bytes for kmsKeyName. |
getParserForType()
public Parser<Secret> getParserForType()| Type | Description |
| Parser<Secret> |
getSecretEnv()
public Map<String,ByteString> getSecretEnv()Use #getSecretEnvMap() instead.
| 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;
| 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;
| 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;
| Name | Description |
| key | String |
| defaultValue | ByteString |
| 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;
| Name | Description |
| key | String |
| Type | Description |
| ByteString |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public Secret.Builder newBuilderForType()| Type | Description |
| Secret.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Secret.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| Secret.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public Secret.Builder toBuilder()| Type | Description |
| Secret.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |