Send feedback
  
   
 
  
    
      Class EncryptionInfo
    
    
       
    
    
      
      Stay organized with collections
     
    
      
      Save and categorize content based on your preferences.
     
    
  
      
     
  
  
   
  
    
  
  
    
    
    
  Version 6.21.2keyboard_arrow_down  
  
 
    
    
     
    
    
    
    
    
      
  
  
  
    
public   final   class  EncryptionInfo   extends   GeneratedMessageV3   implements   EncryptionInfoOrBuilder  
   
   Encryption information for a Cloud Spanner database or backup.
 Protobuf type google.spanner.admin.database.v1.EncryptionInfo
 
  
  
  
  Static Fields
   
  ENCRYPTION_STATUS_FIELD_NUMBER 
  
    
public   static   final   int   ENCRYPTION_STATUS_FIELD_NUMBER  
   
  Field Value 
  
  ENCRYPTION_TYPE_FIELD_NUMBER 
  
    
public   static   final   int   ENCRYPTION_TYPE_FIELD_NUMBER  
   
  Field Value 
  
  KMS_KEY_VERSION_FIELD_NUMBER 
  
    
public   static   final   int   KMS_KEY_VERSION_FIELD_NUMBER  
   
  Field Value 
  
  Static Methods
   
   
  getDefaultInstance() 
  
    
public   static   EncryptionInfo   getDefaultInstance ()  
   
  Returns 
  
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  Returns 
  
   
  newBuilder() 
  
    
public   static   EncryptionInfo . Builder   newBuilder ()  
   
  Returns 
  
   
  newBuilder(EncryptionInfo prototype) 
  
    
public   static   EncryptionInfo . Builder   newBuilder ( EncryptionInfo   prototype )  
   
  Parameter 
  
  Returns 
  
   
  
  
    
public   static   EncryptionInfo   parseDelimitedFrom ( InputStream   input )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   EncryptionInfo   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(byte[] data) 
  
    
public   static   EncryptionInfo   parseFrom ( byte []   data )  
   
  Parameter 
  
    
      
        Name  
        Description  
       
      
        data  
        byte [] 
       
     
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   EncryptionInfo   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(ByteString data) 
  
    
public   static   EncryptionInfo   parseFrom ( ByteString   data )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   EncryptionInfo   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   EncryptionInfo   parseFrom ( CodedInputStream   input )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   EncryptionInfo   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   EncryptionInfo   parseFrom ( InputStream   input )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   EncryptionInfo   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(ByteBuffer data) 
  
    
public   static   EncryptionInfo   parseFrom ( ByteBuffer   data )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   EncryptionInfo   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parser() 
  
    
public   static   Parser<EncryptionInfo>   parser ()  
   
  Returns 
  
  Methods
   
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
   
  Parameter 
  
  Returns 
  
  Overrides 
  
   
  getDefaultInstanceForType() 
  
    
public   EncryptionInfo   getDefaultInstanceForType ()  
   
  Returns 
  
   
  getEncryptionStatus() 
  
    
public   Status   getEncryptionStatus ()  
   
   Output only. If present, the status of a recent encrypt/decrypt call on underlying data
 for this database or backup. Regardless of status, data is always encrypted
 at rest.
 .google.rpc.Status encryption_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        com.google.rpc.Status  
        The encryptionStatus.
 
       
     
  
   
  getEncryptionStatusOrBuilder() 
  
    
public   StatusOrBuilder   getEncryptionStatusOrBuilder ()  
   
   Output only. If present, the status of a recent encrypt/decrypt call on underlying data
 for this database or backup. Regardless of status, data is always encrypted
 at rest.
 .google.rpc.Status encryption_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        com.google.rpc.StatusOrBuilder  
         
       
     
  
   
  getEncryptionType() 
  
    
public   EncryptionInfo . Type   getEncryptionType ()  
   
   Output only. The type of encryption.
 
 .google.spanner.admin.database.v1.EncryptionInfo.Type encryption_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
 
  Returns 
  
   
  getEncryptionTypeValue() 
  
    
public   int   getEncryptionTypeValue ()  
   
   Output only. The type of encryption.
 
 .google.spanner.admin.database.v1.EncryptionInfo.Type encryption_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        int  
        The enum numeric value on the wire for encryptionType.
 
       
     
  
   
  getKmsKeyVersion() 
  
    
public   String   getKmsKeyVersion ()  
   
   Output only. A Cloud KMS key version that is being used to protect the database or
 backup.
 
 string kms_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
 
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        String  
        The kmsKeyVersion.
 
       
     
  
   
  getKmsKeyVersionBytes() 
  
    
public   ByteString   getKmsKeyVersionBytes ()  
   
   Output only. A Cloud KMS key version that is being used to protect the database or
 backup.
 
 string kms_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
 
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for kmsKeyVersion.
 
       
     
  
   
  getParserForType() 
  
    
public   Parser<EncryptionInfo>   getParserForType ()  
   
  Returns 
  
  Overrides 
  
   
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
   
  Returns 
  
  Overrides 
  
   
  getUnknownFields() 
  
    
public   final   UnknownFieldSet   getUnknownFields ()  
   
  Returns 
  
  Overrides 
  
   
  hasEncryptionStatus() 
  
    
public   boolean   hasEncryptionStatus ()  
   
   Output only. If present, the status of a recent encrypt/decrypt call on underlying data
 for this database or backup. Regardless of status, data is always encrypted
 at rest.
 .google.rpc.Status encryption_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        boolean  
        Whether the encryptionStatus field is set.
 
       
     
  
   
  hashCode() 
  
  Returns 
  
  Overrides 
  
   
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  Returns 
  
  Overrides 
  
   
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
   
  Returns 
  
  Overrides 
  
   
  newBuilderForType() 
  
    
public   EncryptionInfo . Builder   newBuilderForType ()  
   
  Returns 
  
   
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   EncryptionInfo . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
   
  Parameter 
  
  Returns 
  
  Overrides 
  
   
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
   
  Parameter 
  
  Returns 
  
  Overrides 
  
   
  toBuilder() 
  
    
public   EncryptionInfo . Builder   toBuilder ()  
   
  Returns 
  
   
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
   
  Parameter 
  
  Overrides 
  
  Exceptions 
  
 
     
    
  
  
  
     
  
 
  
    
    
      
    
     
  
       
         
  
  
    
    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-30 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-30 UTC."],[],[]]