Class CreateBackupRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CreateBackupRequestOrBuilder, Serializable

    public final class CreateBackupRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements CreateBackupRequestOrBuilder
     The request for [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].
     
    Protobuf type google.spanner.admin.database.v1.CreateBackupRequest
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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
      • getParent

        public String getParent()
         Required. The name of the instance in which the backup will be
         created. This must be the same instance that contains the database the
         backup will be created from. The backup will be stored in the
         location(s) specified in the instance configuration of this
         instance. Values are of the form
         `projects/<project>/instances/<instance>`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface CreateBackupRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The name of the instance in which the backup will be
         created. This must be the same instance that contains the database the
         backup will be created from. The backup will be stored in the
         location(s) specified in the instance configuration of this
         instance. Values are of the form
         `projects/<project>/instances/<instance>`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface CreateBackupRequestOrBuilder
        Returns:
        The bytes for parent.
      • getBackupId

        public String getBackupId()
         Required. The id of the backup to be created. The `backup_id` appended to
         `parent` forms the full backup name of the form
         `projects/<project>/instances/<instance>/backups/<backup_id>`.
         
        string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBackupId in interface CreateBackupRequestOrBuilder
        Returns:
        The backupId.
      • getBackupIdBytes

        public com.google.protobuf.ByteString getBackupIdBytes()
         Required. The id of the backup to be created. The `backup_id` appended to
         `parent` forms the full backup name of the form
         `projects/<project>/instances/<instance>/backups/<backup_id>`.
         
        string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBackupIdBytes in interface CreateBackupRequestOrBuilder
        Returns:
        The bytes for backupId.
      • hasBackup

        public boolean hasBackup()
         Required. The backup to create.
         
        .google.spanner.admin.database.v1.Backup backup = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasBackup in interface CreateBackupRequestOrBuilder
        Returns:
        Whether the backup field is set.
      • getBackup

        public Backup getBackup()
         Required. The backup to create.
         
        .google.spanner.admin.database.v1.Backup backup = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBackup in interface CreateBackupRequestOrBuilder
        Returns:
        The backup.
      • hasEncryptionConfig

        public boolean hasEncryptionConfig()
         Optional. The encryption configuration used to encrypt the backup. If this field is
         not specified, the backup will use the same
         encryption configuration as the database by default, namely
         [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.encryption_type] =
         `USE_DATABASE_ENCRYPTION`.
         
        .google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasEncryptionConfig in interface CreateBackupRequestOrBuilder
        Returns:
        Whether the encryptionConfig field is set.
      • getEncryptionConfig

        public CreateBackupEncryptionConfig getEncryptionConfig()
         Optional. The encryption configuration used to encrypt the backup. If this field is
         not specified, the backup will use the same
         encryption configuration as the database by default, namely
         [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.encryption_type] =
         `USE_DATABASE_ENCRYPTION`.
         
        .google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEncryptionConfig in interface CreateBackupRequestOrBuilder
        Returns:
        The encryptionConfig.
      • getEncryptionConfigOrBuilder

        public CreateBackupEncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
         Optional. The encryption configuration used to encrypt the backup. If this field is
         not specified, the backup will use the same
         encryption configuration as the database by default, namely
         [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.encryption_type] =
         `USE_DATABASE_ENCRYPTION`.
         
        .google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEncryptionConfigOrBuilder in interface CreateBackupRequestOrBuilder
      • 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 CreateBackupRequest parseFrom​(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static CreateBackupRequest parseFrom​(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static CreateBackupRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

        protected CreateBackupRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

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