alluxio.wire

Class BackupStatus

java.lang.Object

alluxio.wire.BackupStatus

public class BackupStatus
extends Object

Defines the status of a backup.

Constructor Summary

Constructors

Constructor and Description
BackupStatus(BackupState state) Creates a new backup status with new Id.
BackupStatus(BackupStatus status) Cloning constructor.
BackupStatus(UUID backupId, BackupState state) Creates a new backup status with existing Id.

Method Summary

Modifier and Type	Method and Description
static BackupStatus	fromProto(BackupPStatus pStatus)
UUID	getBackupId()
AlluxioURI	getBackupUri()
long	getEntryCount()
AlluxioException	getError()
String	getHostname()
BackupState	getState()
boolean	isCompleted()
boolean	isFailed()
boolean	isFinished()
void	setBackupId(UUID backupUuid) Sets the unique backup id.
BackupStatus	setBackupUri(AlluxioURI backupUri) Sets the backup uri.
BackupStatus	setEntryCount(long entryCount) Sets entry count.
BackupStatus	setError(AlluxioException error) Fails the backup with given error.
BackupStatus	setHostname(String hostName) Sets the backup host.
BackupStatus	setState(BackupState state) Sets the backup state.
BackupPStatus	toProto()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BackupStatus

public BackupStatus(BackupState state)

Creates a new backup status with new Id.

Parameters:

state - state of the backup

BackupStatus

public BackupStatus(UUID backupId,
                    BackupState state)

Creates a new backup status with existing Id.

Parameters:

backupId - the backup id

state - state of the backup

BackupStatus

public BackupStatus(BackupStatus status)

Cloning constructor.

Parameters:

status - backup status to clone

Method Detail

fromProto

public static BackupStatus fromProto(BackupPStatus pStatus)

Parameters:

pStatus - proto backup status

Returns:

backup status from proto representation

getBackupId

public UUID getBackupId()

Returns:

the unique backup id

setBackupId

public void setBackupId(UUID backupUuid)

Sets the unique backup id.

Parameters:

backupUuid - backup id

getEntryCount

public long getEntryCount()

Returns:

current entry count in the backup

setEntryCount

public BackupStatus setEntryCount(long entryCount)

Sets entry count.

Parameters:

entryCount - the entry count

Returns:

the updated instance

isFinished

public boolean isFinished()

Returns:

true if the backup is finished (completed | failed)

isCompleted

public boolean isCompleted()

Returns:

true if the backup is completed successfully

isFailed

public boolean isFailed()

Returns:

true if the backup is failed

getState

public BackupState getState()

Returns:

the backup state

setState

public BackupStatus setState(BackupState state)

Sets the backup state.

Parameters:

state - the backup state

Returns:

the updated instance

getError

public AlluxioException getError()

Returns:

the error if backup was failed

setError

public BackupStatus setError(AlluxioException error)

Fails the backup with given error. Adjusts the backup state to BackupState.Failed.

Parameters:

error - the backup error

Returns:

the updated instance

getHostname

public String getHostname()

Returns:

the backup host

setHostname

public BackupStatus setHostname(String hostName)

Sets the backup host.

Parameters:

hostName - the backup host

Returns:

the updated instance

getBackupUri

public AlluxioURI getBackupUri()

Returns:

the backup URI

setBackupUri

public BackupStatus setBackupUri(AlluxioURI backupUri)

Sets the backup uri.

Parameters:

backupUri - the backup uri

Returns:

the updated instance

toProto

public BackupPStatus toProto()

Returns:

the proto representation

toString

public String toString()

Overrides:

toString in class Object