Class CopyBackupEncryptionConfig (6.74.0)

public final class CopyBackupEncryptionConfig extends GeneratedMessageV3 implements CopyBackupEncryptionConfigOrBuilder

Encryption configuration for the copied backup.

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

Static Fields

ENCRYPTION_TYPE_FIELD_NUMBER

public static final int ENCRYPTION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_NAMES_FIELD_NUMBER

public static final int KMS_KEY_NAMES_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CopyBackupEncryptionConfig getDefaultInstance()
Returns
Type Description
CopyBackupEncryptionConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CopyBackupEncryptionConfig.Builder newBuilder()
Returns
Type Description
CopyBackupEncryptionConfig.Builder

newBuilder(CopyBackupEncryptionConfig prototype)

public static CopyBackupEncryptionConfig.Builder newBuilder(CopyBackupEncryptionConfig prototype)
Parameter
Name Description
prototype CopyBackupEncryptionConfig
Returns
Type Description
CopyBackupEncryptionConfig.Builder

parseDelimitedFrom(InputStream input)

public static CopyBackupEncryptionConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CopyBackupEncryptionConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CopyBackupEncryptionConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CopyBackupEncryptionConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CopyBackupEncryptionConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CopyBackupEncryptionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CopyBackupEncryptionConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CopyBackupEncryptionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CopyBackupEncryptionConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CopyBackupEncryptionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CopyBackupEncryptionConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CopyBackupEncryptionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CopyBackupEncryptionConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CopyBackupEncryptionConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CopyBackupEncryptionConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CopyBackupEncryptionConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CopyBackupEncryptionConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CopyBackupEncryptionConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CopyBackupEncryptionConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CopyBackupEncryptionConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CopyBackupEncryptionConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CopyBackupEncryptionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CopyBackupEncryptionConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CopyBackupEncryptionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CopyBackupEncryptionConfig> parser()
Returns
Type Description
Parser<CopyBackupEncryptionConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CopyBackupEncryptionConfig getDefaultInstanceForType()
Returns
Type Description
CopyBackupEncryptionConfig

getEncryptionType()

public CopyBackupEncryptionConfig.EncryptionType getEncryptionType()

Required. The encryption type of the backup.

.google.spanner.admin.database.v1.CopyBackupEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CopyBackupEncryptionConfig.EncryptionType

The encryptionType.

getEncryptionTypeValue()

public int getEncryptionTypeValue()

Required. The encryption type of the backup.

.google.spanner.admin.database.v1.CopyBackupEncryptionConfig.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.

getKmsKeyNames(int index)

public String getKmsKeyNames(int index)

Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>. Kms keys specified can be in any order.

The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples:

  • For single region instance configs, specify a single regional location KMS key.
  • For multi-regional 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 an 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.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The kmsKeyNames at the given index.

getKmsKeyNamesBytes(int index)

public ByteString getKmsKeyNamesBytes(int index)

Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>. Kms keys specified can be in any order.

The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples:

  • For single region instance configs, specify a single regional location KMS key.
  • For multi-regional 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 an 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.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the kmsKeyNames at the given index.

getKmsKeyNamesCount()

public int getKmsKeyNamesCount()

Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>. Kms keys specified can be in any order.

The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples:

  • For single region instance configs, specify a single regional location KMS key.
  • For multi-regional 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 an 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.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of kmsKeyNames.

getKmsKeyNamesList()

public ProtocolStringList getKmsKeyNamesList()

Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>. Kms keys specified can be in any order.

The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples:

  • For single region instance configs, specify a single regional location KMS key.
  • For multi-regional 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 an 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.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the kmsKeyNames.

getParserForType()

public Parser<CopyBackupEncryptionConfig> getParserForType()
Returns
Type Description
Parser<CopyBackupEncryptionConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CopyBackupEncryptionConfig.Builder newBuilderForType()
Returns
Type Description
CopyBackupEncryptionConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CopyBackupEncryptionConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CopyBackupEncryptionConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CopyBackupEncryptionConfig.Builder toBuilder()
Returns
Type Description
CopyBackupEncryptionConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException