Class EncryptionConfig (6.89.0) 

publicfinalclassEncryptionConfigextendsGeneratedMessageV3implementsEncryptionConfigOrBuilder

Encryption configuration for a Cloud Spanner database.

Protobuf type google.spanner.admin.database.v1.EncryptionConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > EncryptionConfig

Static Fields

KMS_KEY_NAMES_FIELD_NUMBER

publicstaticfinalintKMS_KEY_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_NAME_FIELD_NUMBER

publicstaticfinalintKMS_KEY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

publicstaticEncryptionConfiggetDefaultInstance()
Returns
TypeDescription
EncryptionConfig

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

publicstaticEncryptionConfig.BuildernewBuilder()
Returns
TypeDescription
EncryptionConfig.Builder

newBuilder(EncryptionConfig prototype)

publicstaticEncryptionConfig.BuildernewBuilder(EncryptionConfigprototype)
Parameter
NameDescription
prototypeEncryptionConfig
Returns
TypeDescription
EncryptionConfig.Builder

parseDelimitedFrom(InputStream input)

publicstaticEncryptionConfigparseDelimitedFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EncryptionConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticEncryptionConfigparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EncryptionConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

publicstaticEncryptionConfigparseFrom(byte[]data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
EncryptionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticEncryptionConfigparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EncryptionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticEncryptionConfigparseFrom(ByteStringdata)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
EncryptionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticEncryptionConfigparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EncryptionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticEncryptionConfigparseFrom(CodedInputStreaminput)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
EncryptionConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticEncryptionConfigparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EncryptionConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

publicstaticEncryptionConfigparseFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EncryptionConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticEncryptionConfigparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EncryptionConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

publicstaticEncryptionConfigparseFrom(ByteBufferdata)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
EncryptionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticEncryptionConfigparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EncryptionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

publicstaticParser<EncryptionConfig>parser()
Returns
TypeDescription
Parser<EncryptionConfig>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

publicEncryptionConfiggetDefaultInstanceForType()
Returns
TypeDescription
EncryptionConfig

getKmsKeyName()

publicStringgetKmsKeyName()

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) = { ... }

Returns
TypeDescription
String

The kmsKeyName.

getKmsKeyNameBytes()

publicByteStringgetKmsKeyNameBytes()

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) = { ... }

Returns
TypeDescription
ByteString

The bytes for kmsKeyName.

getKmsKeyNames(int index)

publicStringgetKmsKeyNames(intindex)

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) = { ... }

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The kmsKeyNames at the given index.

getKmsKeyNamesBytes(int index)

publicByteStringgetKmsKeyNamesBytes(intindex)

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) = { ... }

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the kmsKeyNames at the given index.

getKmsKeyNamesCount()

publicintgetKmsKeyNamesCount()

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) = { ... }

Returns
TypeDescription
int

The count of kmsKeyNames.

getKmsKeyNamesList()

publicProtocolStringListgetKmsKeyNamesList()

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) = { ... }

Returns
TypeDescription
ProtocolStringList

A list containing the kmsKeyNames.

getParserForType()

publicParser<EncryptionConfig>getParserForType()
Returns
TypeDescription
Parser<EncryptionConfig>
Overrides

getSerializedSize()

publicintgetSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

publicinthashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

publicEncryptionConfig.BuildernewBuilderForType()
Returns
TypeDescription
EncryptionConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedEncryptionConfig.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
EncryptionConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

publicEncryptionConfig.BuildertoBuilder()
Returns
TypeDescription
EncryptionConfig.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException