Class RestoreDatabaseRequest

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

    public final class RestoreDatabaseRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements RestoreDatabaseRequestOrBuilder
     The request for
     [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].
     
    Protobuf type google.spanner.admin.database.v1.RestoreDatabaseRequest
    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 to create the
         restored database. This instance must be in the same project and
         have the same instance configuration as the instance containing
         the source backup. 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 RestoreDatabaseRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The name of the instance in which to create the
         restored database. This instance must be in the same project and
         have the same instance configuration as the instance containing
         the source backup. 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 RestoreDatabaseRequestOrBuilder
        Returns:
        The bytes for parent.
      • getDatabaseId

        public String getDatabaseId()
         Required. The id of the database to create and restore to. This
         database must not already exist. The `database_id` appended to
         `parent` forms the full database name of the form
         `projects/<project>/instances/<instance>/databases/<database_id>`.
         
        string database_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDatabaseId in interface RestoreDatabaseRequestOrBuilder
        Returns:
        The databaseId.
      • getDatabaseIdBytes

        public com.google.protobuf.ByteString getDatabaseIdBytes()
         Required. The id of the database to create and restore to. This
         database must not already exist. The `database_id` appended to
         `parent` forms the full database name of the form
         `projects/<project>/instances/<instance>/databases/<database_id>`.
         
        string database_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDatabaseIdBytes in interface RestoreDatabaseRequestOrBuilder
        Returns:
        The bytes for databaseId.
      • hasBackup

        public boolean hasBackup()
         Name of the backup from which to restore.  Values are of the form
         `projects/<project>/instances/<instance>/backups/<backup>`.
         
        string backup = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        hasBackup in interface RestoreDatabaseRequestOrBuilder
        Returns:
        Whether the backup field is set.
      • getBackup

        public String getBackup()
         Name of the backup from which to restore.  Values are of the form
         `projects/<project>/instances/<instance>/backups/<backup>`.
         
        string backup = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getBackup in interface RestoreDatabaseRequestOrBuilder
        Returns:
        The backup.
      • getBackupBytes

        public com.google.protobuf.ByteString getBackupBytes()
         Name of the backup from which to restore.  Values are of the form
         `projects/<project>/instances/<instance>/backups/<backup>`.
         
        string backup = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getBackupBytes in interface RestoreDatabaseRequestOrBuilder
        Returns:
        The bytes for backup.
      • hasEncryptionConfig

        public boolean hasEncryptionConfig()
         Optional. An encryption configuration describing the encryption type and key
         resources in Cloud KMS used to encrypt/decrypt the database to restore to.
         If this field is not specified, the restored database will use
         the same encryption configuration as the backup by default, namely
         [encryption_type][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.encryption_type] =
         `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
         
        .google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasEncryptionConfig in interface RestoreDatabaseRequestOrBuilder
        Returns:
        Whether the encryptionConfig field is set.
      • getEncryptionConfig

        public RestoreDatabaseEncryptionConfig getEncryptionConfig()
         Optional. An encryption configuration describing the encryption type and key
         resources in Cloud KMS used to encrypt/decrypt the database to restore to.
         If this field is not specified, the restored database will use
         the same encryption configuration as the backup by default, namely
         [encryption_type][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.encryption_type] =
         `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
         
        .google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEncryptionConfig in interface RestoreDatabaseRequestOrBuilder
        Returns:
        The encryptionConfig.
      • getEncryptionConfigOrBuilder

        public RestoreDatabaseEncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
         Optional. An encryption configuration describing the encryption type and key
         resources in Cloud KMS used to encrypt/decrypt the database to restore to.
         If this field is not specified, the restored database will use
         the same encryption configuration as the backup by default, namely
         [encryption_type][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.encryption_type] =
         `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
         
        .google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEncryptionConfigOrBuilder in interface RestoreDatabaseRequestOrBuilder
      • 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 RestoreDatabaseRequest parseFrom​(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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