public final class CreateBackupEncryptionConfig extends GeneratedMessageV3 implements CreateBackupEncryptionConfigOrBuilder
Encryption configuration for the backup to create.
Protobuf type google.spanner.admin.database.v1.CreateBackupEncryptionConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 CreateBackupEncryptionConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CreateBackupEncryptionConfig.Builder newBuilder()
newBuilder(CreateBackupEncryptionConfig prototype)
public static CreateBackupEncryptionConfig.Builder newBuilder(CreateBackupEncryptionConfig prototype)
public static CreateBackupEncryptionConfig parseDelimitedFrom(InputStream input)
public static CreateBackupEncryptionConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CreateBackupEncryptionConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CreateBackupEncryptionConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CreateBackupEncryptionConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateBackupEncryptionConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateBackupEncryptionConfig parseFrom(CodedInputStream input)
public static CreateBackupEncryptionConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CreateBackupEncryptionConfig parseFrom(InputStream input)
public static CreateBackupEncryptionConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CreateBackupEncryptionConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CreateBackupEncryptionConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CreateBackupEncryptionConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public CreateBackupEncryptionConfig getDefaultInstanceForType()
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];
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 |
| 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>.
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>.
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>.
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>.
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) = { ... }
getParserForType()
public Parser<CreateBackupEncryptionConfig> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CreateBackupEncryptionConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CreateBackupEncryptionConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CreateBackupEncryptionConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
