Send feedback
  
   
 
  
    
      Class CreateBackupEncryptionConfig.Builder
    
    
      
      
      Stay organized with collections
     
    
      
      Save and categorize content based on your preferences.
     
    
  
  
   
  
    
  
  
    
    
    
    
  Version 6.20.0keyboard_arrow_down  
  
 
    
    
    
      
  
  
  
    
public   static   final   class  CreateBackupEncryptionConfig . Builder   extends   GeneratedMessageV3 . Builder<CreateBackupEncryptionConfig . Builder >  implements   CreateBackupEncryptionConfigOrBuilder  
   Encryption configuration for the backup to create.
 Protobuf type google.spanner.admin.database.v1.CreateBackupEncryptionConfig
Static Methods
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  Returns 
  
  Methods
   
  addRepeatedField(Descriptors.FieldDescriptor field, Object value) 
  
    
public   CreateBackupEncryptionConfig . Builder   addRepeatedField ( Descriptors . FieldDescriptor   field ,   Object   value )  
  Parameters 
  
  Returns 
  
  Overrides 
  
  build() 
  
    
public   CreateBackupEncryptionConfig   build ()  
  Returns 
  
  buildPartial() 
  
    
public   CreateBackupEncryptionConfig   buildPartial ()  
  Returns 
  
  clear() 
  
    
public   CreateBackupEncryptionConfig . Builder   clear ()  
  Returns 
  
  Overrides 
  
  clearEncryptionType() 
  
    
public   CreateBackupEncryptionConfig . Builder   clearEncryptionType ()  
   Required. The encryption type of the backup.
 
 .google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];
 
Returns 
  
  clearField(Descriptors.FieldDescriptor field) 
  
    
public   CreateBackupEncryptionConfig . Builder   clearField ( Descriptors . FieldDescriptor   field )  
  Parameter 
  
  Returns 
  
  Overrides 
  
  clearKmsKeyName() 
  
    
public   CreateBackupEncryptionConfig . Builder   clearKmsKeyName ()  
   Optional. The Cloud KMS key that will be used to protect the backup.
 This field should be set only when
 encryption_type  is
 CUSTOMER_MANAGED_ENCRYPTION. Values are of the form
 projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
 
 string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
 
Returns 
  
  clearOneof(Descriptors.OneofDescriptor oneof) 
  
    
public   CreateBackupEncryptionConfig . Builder   clearOneof ( Descriptors . OneofDescriptor   oneof )  
  Parameter 
  
  Returns 
  
  Overrides 
  
  clone() 
  
    
public   CreateBackupEncryptionConfig . Builder   clone ()  
  Returns 
  
  Overrides 
  
  getDefaultInstanceForType() 
  
    
public   CreateBackupEncryptionConfig   getDefaultInstanceForType ()  
  Returns 
  
  getDescriptorForType() 
  
    
public   Descriptors . Descriptor   getDescriptorForType ()  
  Returns 
  
  Overrides 
  
  getEncryptionType() 
  
    
public   CreateBackupEncryptionConfig . EncryptionType   getEncryptionType ()  
   Required. The encryption type of the backup.
 
 .google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];
 
Returns 
  
  getEncryptionTypeValue() 
  
    
public   int   getEncryptionTypeValue ()  
   Required. The encryption type of the backup.
 
 .google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];
 
Returns 
  
    
      
        Type Description  
      
        int The enum numeric value on the wire for encryptionType.
 
     
  
  getKmsKeyName() 
  
    
public   String   getKmsKeyName ()  
   Optional. The Cloud KMS key that will be used to protect the backup.
 This field should be set only when
 encryption_type  is
 CUSTOMER_MANAGED_ENCRYPTION. Values are of the form
 projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
 
 string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
 
Returns 
  
    
      
        Type Description  
      
        String The kmsKeyName.
 
     
  
  getKmsKeyNameBytes() 
  
    
public   ByteString   getKmsKeyNameBytes ()  
   Optional. The Cloud KMS key that will be used to protect the backup.
 This field should be set only when
 encryption_type  is
 CUSTOMER_MANAGED_ENCRYPTION. Values are of the form
 projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
 
 string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
 
Returns 
  
    
      
        Type Description  
      
        ByteString The bytes for kmsKeyName.
 
     
  
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  Returns 
  
  Overrides 
  
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
  Returns 
  
  Overrides 
  
  
    
public   CreateBackupEncryptionConfig . Builder   mergeFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  Parameters 
  
  Returns 
  
  Overrides 
  
  Exceptions 
  
  mergeFrom(Message other) 
  
    
public   CreateBackupEncryptionConfig . Builder   mergeFrom ( Message   other )  
  Parameter 
  
  Returns 
  
  Overrides 
  
  mergeFrom(CreateBackupEncryptionConfig other) 
  
    
public   CreateBackupEncryptionConfig . Builder   mergeFrom ( CreateBackupEncryptionConfig   other )  
  Parameter 
  
  Returns 
  
  mergeUnknownFields(UnknownFieldSet unknownFields) 
  
    
public   final   CreateBackupEncryptionConfig . Builder   mergeUnknownFields ( UnknownFieldSet   unknownFields )  
  Parameter 
  
  Returns 
  
  Overrides 
  
  setEncryptionType(CreateBackupEncryptionConfig.EncryptionType value) 
  
    
public   CreateBackupEncryptionConfig . Builder   setEncryptionType ( CreateBackupEncryptionConfig . EncryptionType   value )  
   Required. The encryption type of the backup.
 
 .google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];
 
Parameter 
  
  Returns 
  
  setEncryptionTypeValue(int value) 
  
    
public   CreateBackupEncryptionConfig . Builder   setEncryptionTypeValue ( int   value )  
   Required. The encryption type of the backup.
 
 .google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];
 
Parameter 
  
    
      
        Name Description  
      
        value int The enum numeric value on the wire for encryptionType to set.
 
     
  
  Returns 
  
  setField(Descriptors.FieldDescriptor field, Object value) 
  
    
public   CreateBackupEncryptionConfig . Builder   setField ( Descriptors . FieldDescriptor   field ,   Object   value )  
  Parameters 
  
  Returns 
  
  Overrides 
  
  setKmsKeyName(String value) 
  
    
public   CreateBackupEncryptionConfig . Builder   setKmsKeyName ( String   value )  
   Optional. The Cloud KMS key that will be used to protect the backup.
 This field should be set only when
 encryption_type  is
 CUSTOMER_MANAGED_ENCRYPTION. Values are of the form
 projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
 
 string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
 
Parameter 
  
    
      
        Name Description  
      
        value String The kmsKeyName to set.
 
     
  
  Returns 
  
  setKmsKeyNameBytes(ByteString value) 
  
    
public   CreateBackupEncryptionConfig . Builder   setKmsKeyNameBytes ( ByteString   value )  
   Optional. The Cloud KMS key that will be used to protect the backup.
 This field should be set only when
 encryption_type  is
 CUSTOMER_MANAGED_ENCRYPTION. Values are of the form
 projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
 
 string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
 
Parameter 
  
    
      
        Name Description  
      
        value ByteString The bytes for kmsKeyName to set.
 
     
  
  Returns 
  
  setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value) 
  
    
public   CreateBackupEncryptionConfig . Builder   setRepeatedField ( Descriptors . FieldDescriptor   field ,   int   index ,   Object   value )  
  Parameters 
  
  Returns 
  
  Overrides 
  
  setUnknownFields(UnknownFieldSet unknownFields) 
  
    
public   final   CreateBackupEncryptionConfig . Builder   setUnknownFields ( UnknownFieldSet   unknownFields )  
  Parameter 
  
  Returns 
  
  Overrides 
  
 
     
    
  
  
  
     
  
    
    
      
    
     
  
       
         
  
  
    
    Send feedback
  
   
 
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-29 UTC.
 
 
  
  
    
    
    
      
  
  
    Need to tell us more?
  
   
 
     
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]