Package com.google.cloudbuild.v1

Class Secret.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Secret.Builder>
com.google.cloudbuild.v1.Secret.Builder
All Implemented Interfaces:
SecretOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Secret
public static final class Secret.Builder extends com.google.protobuf.GeneratedMessage.Builder<Secret.Builder> 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

  • Method Summary

    Modifier and Type
    Method
    Description
    Secret
    build()
     
    Secret
    buildPartial()
     
    Secret.Builder
    clear()
     
    Secret.Builder
    clearKmsKeyName()
    Cloud KMS key name to use to decrypt these envs.
    Secret.Builder
    clearSecretEnv()
     
    boolean
    containsSecretEnv(String key)
    Map of environment variable name to its encrypted value.
    Secret
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getKmsKeyName()
    Cloud KMS key name to use to decrypt these envs.
    com.google.protobuf.ByteString
    getKmsKeyNameBytes()
    Cloud KMS key name to use to decrypt these envs.
    Map<String,com.google.protobuf.ByteString>
    getMutableSecretEnv()
    Deprecated.
    Map<String,com.google.protobuf.ByteString>
    getSecretEnv()
    Deprecated.
    int
    getSecretEnvCount()
    Map of environment variable name to its encrypted value.
    Map<String,com.google.protobuf.ByteString>
    getSecretEnvMap()
    Map of environment variable name to its encrypted value.
    com.google.protobuf.ByteString
    getSecretEnvOrDefault(String key, com.google.protobuf.ByteString defaultValue)
    Map of environment variable name to its encrypted value.
    com.google.protobuf.ByteString
    getSecretEnvOrThrow(String key)
    Map of environment variable name to its encrypted value.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMutableMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    Secret.Builder
    mergeFrom(Secret other)
     
    Secret.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    Secret.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    Secret.Builder
    putAllSecretEnv(Map<String,com.google.protobuf.ByteString> values)
    Map of environment variable name to its encrypted value.
    Secret.Builder
    putSecretEnv(String key, com.google.protobuf.ByteString value)
    Map of environment variable name to its encrypted value.
    Secret.Builder
    removeSecretEnv(String key)
    Map of environment variable name to its encrypted value.
    Secret.Builder
    setKmsKeyName(String value)
    Cloud KMS key name to use to decrypt these envs.
    Secret.Builder
    setKmsKeyNameBytes(com.google.protobuf.ByteString value)
    Cloud KMS key name to use to decrypt these envs.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Secret.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Secret.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Secret.Builder>

    • clear

      public Secret.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Secret.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Secret.Builder>

    • getDefaultInstanceForType

      public Secret getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Secret build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Secret buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Secret.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Secret.Builder>

    • mergeFrom

      public Secret.Builder mergeFrom(Secret other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Secret.Builder>

    • mergeFrom

      public Secret.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Secret.Builder>
      Throws:
      IOException

    • getKmsKeyName

      public String getKmsKeyName()
       Cloud KMS key name to use to decrypt these envs.
      string kms_key_name = 1;
      Specified by:
      getKmsKeyName in interface SecretOrBuilder
      Returns:
      The kmsKeyName.

    • getKmsKeyNameBytes

      public com.google.protobuf.ByteString getKmsKeyNameBytes()
       Cloud KMS key name to use to decrypt these envs.
      string kms_key_name = 1;
      Specified by:
      getKmsKeyNameBytes in interface SecretOrBuilder
      Returns:
      The bytes for kmsKeyName.

    • setKmsKeyName

      public Secret.Builder setKmsKeyName(String value)
       Cloud KMS key name to use to decrypt these envs.
      string kms_key_name = 1;
      Parameters:
      value - The kmsKeyName to set.
      Returns:
      This builder for chaining.

    • clearKmsKeyName

      public Secret.Builder clearKmsKeyName()
       Cloud KMS key name to use to decrypt these envs.
      string kms_key_name = 1;
      Returns:
      This builder for chaining.

    • setKmsKeyNameBytes

      public Secret.Builder setKmsKeyNameBytes(com.google.protobuf.ByteString value)
       Cloud KMS key name to use to decrypt these envs.
      string kms_key_name = 1;
      Parameters:
      value - The bytes for kmsKeyName to set.
      Returns:
      This builder for chaining.

    • getSecretEnvCount

      public int getSecretEnvCount()
      Description copied from interface: SecretOrBuilder
       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;
      Specified by:
      getSecretEnvCount in interface SecretOrBuilder

    • containsSecretEnv

      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;
      Specified by:
      containsSecretEnv in interface SecretOrBuilder

    • getSecretEnv

      @Deprecated public Map<String,com.google.protobuf.ByteString> getSecretEnv()
      Deprecated.
      Use getSecretEnvMap() instead.
      Specified by:
      getSecretEnv in interface SecretOrBuilder

    • getSecretEnvMap

      public Map<String,com.google.protobuf.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;
      Specified by:
      getSecretEnvMap in interface SecretOrBuilder

    • getSecretEnvOrDefault

      public com.google.protobuf.ByteString getSecretEnvOrDefault(String key, com.google.protobuf.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;
      Specified by:
      getSecretEnvOrDefault in interface SecretOrBuilder

    • getSecretEnvOrThrow

      public com.google.protobuf.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;
      Specified by:
      getSecretEnvOrThrow in interface SecretOrBuilder

    • clearSecretEnv

      public Secret.Builder clearSecretEnv()

    • removeSecretEnv

      public Secret.Builder removeSecretEnv(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;

    • getMutableSecretEnv

      @Deprecated public Map<String,com.google.protobuf.ByteString> getMutableSecretEnv()
      Deprecated.
      Use alternate mutation accessors instead.

    • putSecretEnv

      public Secret.Builder putSecretEnv(String key, com.google.protobuf.ByteString value)
       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;

    • putAllSecretEnv

      public Secret.Builder putAllSecretEnv(Map<String,com.google.protobuf.ByteString> values)
       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;