Class CustomerManagedEncryption

  • All Implemented Interfaces:
    CustomerManagedEncryptionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class CustomerManagedEncryption
    extends com.google.protobuf.GeneratedMessageV3
    implements CustomerManagedEncryptionOrBuilder
     Configuration for encrypting secret payloads using customer-managed
     encryption keys (CMEK).
     
    Protobuf type google.cloud.secretmanager.v1.CustomerManagedEncryption
    See Also:
    Serialized Form
    • Field Detail

      • KMS_KEY_NAME_FIELD_NUMBER

        public static final int KMS_KEY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getKmsKeyName

        public String getKmsKeyName()
         Required. The resource name of the Cloud KMS CryptoKey used to encrypt
         secret payloads.
        
         For secrets using the
         [UserManaged][google.cloud.secretmanager.v1.Replication.UserManaged]
         replication policy type, Cloud KMS CryptoKeys must reside in the same
         location as the [replica location][Secret.UserManaged.Replica.location].
        
         For secrets using the
         [Automatic][google.cloud.secretmanager.v1.Replication.Automatic]
         replication policy type, Cloud KMS CryptoKeys must reside in `global`.
        
         The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
         
        string kms_key_name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getKmsKeyName in interface CustomerManagedEncryptionOrBuilder
        Returns:
        The kmsKeyName.
      • getKmsKeyNameBytes

        public com.google.protobuf.ByteString getKmsKeyNameBytes()
         Required. The resource name of the Cloud KMS CryptoKey used to encrypt
         secret payloads.
        
         For secrets using the
         [UserManaged][google.cloud.secretmanager.v1.Replication.UserManaged]
         replication policy type, Cloud KMS CryptoKeys must reside in the same
         location as the [replica location][Secret.UserManaged.Replica.location].
        
         For secrets using the
         [Automatic][google.cloud.secretmanager.v1.Replication.Automatic]
         replication policy type, Cloud KMS CryptoKeys must reside in `global`.
        
         The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
         
        string kms_key_name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getKmsKeyNameBytes in interface CustomerManagedEncryptionOrBuilder
        Returns:
        The bytes for kmsKeyName.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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 CustomerManagedEncryption parseFrom​(ByteBuffer data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static CustomerManagedEncryption parseFrom​(com.google.protobuf.ByteString data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

        protected CustomerManagedEncryption.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<CustomerManagedEncryption> 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.GeneratedMessageV3
      • getDefaultInstanceForType

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