Package com.google.cloudbuild.v1

Class Secret

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloudbuild.v1.Secret
All Implemented Interfaces:
SecretOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Secret extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Secret.Builder
    Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    KMS_KEY_NAME_FIELD_NUMBER
     
    static final int
    SECRET_ENV_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsSecretEnv(String key)
    Map of environment variable name to its encrypted value.
    boolean
    equals(Object obj)
     
    static Secret
    getDefaultInstance()
     
    Secret
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<Secret>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static Secret.Builder
    newBuilder()
     
    static Secret.Builder
    newBuilder(Secret prototype)
     
    Secret.Builder
    newBuilderForType()
     
    protected Secret.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Secret
    parseDelimitedFrom(InputStream input)
     
    static Secret
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Secret
    parseFrom(byte[] data)
     
    static Secret
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Secret
    parseFrom(com.google.protobuf.ByteString data)
     
    static Secret
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Secret
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Secret
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Secret
    parseFrom(InputStream input)
     
    static Secret
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Secret
    parseFrom(ByteBuffer data)
     
    static Secret
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Secret>
    parser()
     
    Secret.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • KMS_KEY_NAME_FIELD_NUMBER

      public static final int KMS_KEY_NAME_FIELD_NUMBER
      See Also:

    • SECRET_ENV_FIELD_NUMBER

      public static final int SECRET_ENV_FIELD_NUMBER
      See Also:

  • 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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.

    • 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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Secret parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Secret parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Secret parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Secret parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Secret parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Secret parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Secret parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Secret parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Secret parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Secret parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Secret parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Secret parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Secret.Builder newBuilder()

    • newBuilder

      public static Secret.Builder newBuilder(Secret prototype)

    • toBuilder

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

    • newBuilderForType

      protected Secret.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Secret getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Secret> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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