Package com.google.spanner.admin.database.v1

Class EncryptionConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.admin.database.v1.EncryptionConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, EncryptionConfigOrBuilder, Serializable
public final class EncryptionConfig extends com.google.protobuf.GeneratedMessageV3 implements EncryptionConfigOrBuilder
 Encryption configuration for a Cloud Spanner database.
Protobuf type google.spanner.admin.database.v1.EncryptionConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    EncryptionConfig.Builder
    Encryption configuration for a Cloud Spanner database.

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    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
    KMS_KEY_NAMES_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, 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
    equals(Object obj)
     
    static EncryptionConfig
    getDefaultInstance()
     
    EncryptionConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getKmsKeyName()
    The Cloud KMS key to be used for encrypting and decrypting the database.
    com.google.protobuf.ByteString
    getKmsKeyNameBytes()
    The Cloud KMS key to be used for encrypting and decrypting the database.
    String
    getKmsKeyNames(int index)
    Specifies the KMS configuration for the one or more keys used to encrypt the database.
    com.google.protobuf.ByteString
    getKmsKeyNamesBytes(int index)
    Specifies the KMS configuration for the one or more keys used to encrypt the database.
    int
    getKmsKeyNamesCount()
    Specifies the KMS configuration for the one or more keys used to encrypt the database.
    com.google.protobuf.ProtocolStringList
    getKmsKeyNamesList()
    Specifies the KMS configuration for the one or more keys used to encrypt the database.
    com.google.protobuf.Parser<EncryptionConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static EncryptionConfig.Builder
    newBuilder()
     
    static EncryptionConfig.Builder
    newBuilder(EncryptionConfig prototype)
     
    EncryptionConfig.Builder
    newBuilderForType()
     
    protected EncryptionConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static EncryptionConfig
    parseDelimitedFrom(InputStream input)
     
    static EncryptionConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EncryptionConfig
    parseFrom(byte[] data)
     
    static EncryptionConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EncryptionConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static EncryptionConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EncryptionConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static EncryptionConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EncryptionConfig
    parseFrom(InputStream input)
     
    static EncryptionConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EncryptionConfig
    parseFrom(ByteBuffer data)
     
    static EncryptionConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<EncryptionConfig>
    parser()
     
    EncryptionConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, 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:

    • KMS_KEY_NAMES_FIELD_NUMBER

      public static final int KMS_KEY_NAMES_FIELD_NUMBER
      See Also:

  • Method Details

    • 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()
       The Cloud KMS key to be used for encrypting and decrypting
 the database. Values are of the form
 `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
      string kms_key_name = 2 [(.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKeyName in interface EncryptionConfigOrBuilder
      Returns:
      The kmsKeyName.

    • getKmsKeyNameBytes

      public com.google.protobuf.ByteString getKmsKeyNameBytes()
       The Cloud KMS key to be used for encrypting and decrypting
 the database. Values are of the form
 `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
      string kms_key_name = 2 [(.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKeyNameBytes in interface EncryptionConfigOrBuilder
      Returns:
      The bytes for kmsKeyName.

    • getKmsKeyNamesList

      public com.google.protobuf.ProtocolStringList getKmsKeyNamesList()
       Specifies the KMS configuration for the one or more keys used to encrypt
 the database. Values are of the form
 `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.

 The keys referenced by kms_key_names must fully cover all
 regions of the database instance configuration. Some examples:
 * For single region database instance configs, specify a single regional
 location KMS key.
 * For multi-regional database instance configs of type GOOGLE_MANAGED,
 either specify a multi-regional location KMS key or multiple regional
 location KMS keys that cover all regions in the instance config.
 * For a database instance config of type USER_MANAGED, please specify only
 regional location KMS keys to cover each region in the instance config.
 Multi-regional location KMS keys are not supported for USER_MANAGED
 instance configs.
      repeated string kms_key_names = 3 [(.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKeyNamesList in interface EncryptionConfigOrBuilder
      Returns:
      A list containing the kmsKeyNames.

    • getKmsKeyNamesCount

      public int getKmsKeyNamesCount()
       Specifies the KMS configuration for the one or more keys used to encrypt
 the database. Values are of the form
 `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.

 The keys referenced by kms_key_names must fully cover all
 regions of the database instance configuration. Some examples:
 * For single region database instance configs, specify a single regional
 location KMS key.
 * For multi-regional database instance configs of type GOOGLE_MANAGED,
 either specify a multi-regional location KMS key or multiple regional
 location KMS keys that cover all regions in the instance config.
 * For a database instance config of type USER_MANAGED, please specify only
 regional location KMS keys to cover each region in the instance config.
 Multi-regional location KMS keys are not supported for USER_MANAGED
 instance configs.
      repeated string kms_key_names = 3 [(.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKeyNamesCount in interface EncryptionConfigOrBuilder
      Returns:
      The count of kmsKeyNames.

    • getKmsKeyNames

      public String getKmsKeyNames(int index)
       Specifies the KMS configuration for the one or more keys used to encrypt
 the database. Values are of the form
 `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.

 The keys referenced by kms_key_names must fully cover all
 regions of the database instance configuration. Some examples:
 * For single region database instance configs, specify a single regional
 location KMS key.
 * For multi-regional database instance configs of type GOOGLE_MANAGED,
 either specify a multi-regional location KMS key or multiple regional
 location KMS keys that cover all regions in the instance config.
 * For a database instance config of type USER_MANAGED, please specify only
 regional location KMS keys to cover each region in the instance config.
 Multi-regional location KMS keys are not supported for USER_MANAGED
 instance configs.
      repeated string kms_key_names = 3 [(.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKeyNames in interface EncryptionConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The kmsKeyNames at the given index.

    • getKmsKeyNamesBytes

      public com.google.protobuf.ByteString getKmsKeyNamesBytes(int index)
       Specifies the KMS configuration for the one or more keys used to encrypt
 the database. Values are of the form
 `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.

 The keys referenced by kms_key_names must fully cover all
 regions of the database instance configuration. Some examples:
 * For single region database instance configs, specify a single regional
 location KMS key.
 * For multi-regional database instance configs of type GOOGLE_MANAGED,
 either specify a multi-regional location KMS key or multiple regional
 location KMS keys that cover all regions in the instance config.
 * For a database instance config of type USER_MANAGED, please specify only
 regional location KMS keys to cover each region in the instance config.
 Multi-regional location KMS keys are not supported for USER_MANAGED
 instance configs.
      repeated string kms_key_names = 3 [(.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKeyNamesBytes in interface EncryptionConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the kmsKeyNames at the given index.

    • 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 EncryptionConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static EncryptionConfig.Builder newBuilder()

    • newBuilder

      public static EncryptionConfig.Builder newBuilder(EncryptionConfig prototype)

    • toBuilder

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

    • newBuilderForType

      protected EncryptionConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static EncryptionConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<EncryptionConfig> 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 EncryptionConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder