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

Class CreateBackupEncryptionConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.admin.database.v1.CreateBackupEncryptionConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CreateBackupEncryptionConfigOrBuilder, Serializable
public final class CreateBackupEncryptionConfig extends com.google.protobuf.GeneratedMessageV3 implements CreateBackupEncryptionConfigOrBuilder
 Encryption configuration for the backup to create.
Protobuf type google.spanner.admin.database.v1.CreateBackupEncryptionConfig
See Also:

  • Field Details

    • ENCRYPTION_TYPE_FIELD_NUMBER

      public static final int ENCRYPTION_TYPE_FIELD_NUMBER
      See Also:

    • 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

    • 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];
      Specified by:
      getEncryptionTypeValue in interface CreateBackupEncryptionConfigOrBuilder
      Returns:
      The enum numeric value on the wire for encryptionType.

    • 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];
      Specified by:
      getEncryptionType in interface CreateBackupEncryptionConfigOrBuilder
      Returns:
      The 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][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.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) = { ... }
      Specified by:
      getKmsKeyName in interface CreateBackupEncryptionConfigOrBuilder
      Returns:
      The kmsKeyName.

    • getKmsKeyNameBytes

      public com.google.protobuf.ByteString getKmsKeyNameBytes()
       Optional. The Cloud KMS key that will be used to protect the backup.
 This field should be set only when
 [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.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) = { ... }
      Specified by:
      getKmsKeyNameBytes in interface CreateBackupEncryptionConfigOrBuilder
      Returns:
      The bytes for kmsKeyName.

    • getKmsKeyNamesList

      public com.google.protobuf.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) = { ... }
      Specified by:
      getKmsKeyNamesList in interface CreateBackupEncryptionConfigOrBuilder
      Returns:
      A list containing the kmsKeyNames.

    • 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) = { ... }
      Specified by:
      getKmsKeyNamesCount in interface CreateBackupEncryptionConfigOrBuilder
      Returns:
      The count of kmsKeyNames.

    • getKmsKeyNames

      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) = { ... }
      Specified by:
      getKmsKeyNames in interface CreateBackupEncryptionConfigOrBuilder
      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)
       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) = { ... }
      Specified by:
      getKmsKeyNamesBytes in interface CreateBackupEncryptionConfigOrBuilder
      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 CreateBackupEncryptionConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CreateBackupEncryptionConfig.Builder newBuilder()

    • newBuilder

      public static CreateBackupEncryptionConfig.Builder newBuilder(CreateBackupEncryptionConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CreateBackupEncryptionConfig getDefaultInstance()

    • parser

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

    • getParserForType

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