Class CreateBackupEncryptionConfig (6.25.1)

public final class CreateBackupEncryptionConfig extends GeneratedMessageV3 implements CreateBackupEncryptionConfigOrBuilder

Encryption configuration for the backup to create.

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

Static Fields

ENCRYPTION_TYPE_FIELD_NUMBER

public static final int ENCRYPTION_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateBackupEncryptionConfig getDefaultInstance()
Returns
TypeDescription
CreateBackupEncryptionConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CreateBackupEncryptionConfig.Builder newBuilder()
Returns
TypeDescription
CreateBackupEncryptionConfig.Builder

newBuilder(CreateBackupEncryptionConfig prototype)

public static CreateBackupEncryptionConfig.Builder newBuilder(CreateBackupEncryptionConfig prototype)
Parameter
NameDescription
prototypeCreateBackupEncryptionConfig
Returns
TypeDescription
CreateBackupEncryptionConfig.Builder

parseDelimitedFrom(InputStream input)

public static CreateBackupEncryptionConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateBackupEncryptionConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateBackupEncryptionConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateBackupEncryptionConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateBackupEncryptionConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateBackupEncryptionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateBackupEncryptionConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateBackupEncryptionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateBackupEncryptionConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateBackupEncryptionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateBackupEncryptionConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateBackupEncryptionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateBackupEncryptionConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateBackupEncryptionConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateBackupEncryptionConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateBackupEncryptionConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateBackupEncryptionConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateBackupEncryptionConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateBackupEncryptionConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateBackupEncryptionConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateBackupEncryptionConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateBackupEncryptionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateBackupEncryptionConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateBackupEncryptionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateBackupEncryptionConfig> parser()
Returns
TypeDescription
Parser<CreateBackupEncryptionConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CreateBackupEncryptionConfig getDefaultInstanceForType()
Returns
TypeDescription
CreateBackupEncryptionConfig

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
TypeDescription
CreateBackupEncryptionConfig.EncryptionType

The encryptionType.

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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for kmsKeyName.

getParserForType()

public Parser<CreateBackupEncryptionConfig> getParserForType()
Returns
TypeDescription
Parser<CreateBackupEncryptionConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateBackupEncryptionConfig.Builder newBuilderForType()
Returns
TypeDescription
CreateBackupEncryptionConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateBackupEncryptionConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateBackupEncryptionConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateBackupEncryptionConfig.Builder toBuilder()
Returns
TypeDescription
CreateBackupEncryptionConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException