com.netflix.priam.backup

Class BackupMetadata

java.lang.Object

com.netflix.priam.backup.BackupMetadata

All Implemented Interfaces:

java.io.Serializable

public final class BackupMetadata
extends java.lang.Object
implements java.io.Serializable

POJO to encapsulate the metadata for a snapshot Created by aagrawal on 1/31/17.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BackupMetadata(BackupVersion backupVersion, java.lang.String token, java.util.Date start)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
BackupVersion	getBackupVersion() Get the backup version for the snapshot.
java.util.Date	getCompleted() Get the date on which snapshot was marked as finished/failed etc.
java.util.Date	getLastValidated() Return the last validation timestamp of this backup metadata.
java.lang.String	getSnapshotDate() Get the snapshot date formatted in yyyyMMdd.
java.lang.String	getSnapshotLocation() Get the snapshot location where snapshot is uploaded.
java.util.Date	getStart() Get the start date on which snapshot was initiated.
Status	getStatus() Get the status of the snapshot.
java.lang.String	getToken() Get the token for which snapshot was initiated.
int	hashCode()
boolean	isCassandraSnapshotSuccess() Find if cassandra snapshot was successful or not.
void	setCassandraSnapshotSuccess(boolean cassandraSnapshotSuccess) Set the cassandra snapshot status to be either finished successfully or fail.
void	setCompleted(java.util.Date completed) Set the completion date of snashot status.
void	setLastValidated(java.util.Date lastValidated) Set the last validation date of backup metadata.
void	setSnapshotLocation(java.lang.String snapshotLocation) Set the snapshot location where snapshot is uploaded.
void	setStatus(Status status) Set the status of the snapshot.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BackupMetadata

public BackupMetadata(BackupVersion backupVersion,
                      java.lang.String token,
                      java.util.Date start)
               throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getSnapshotDate

public java.lang.String getSnapshotDate()

Get the snapshot date formatted in yyyyMMdd.

Returns:

snapshot date formatted in yyyyMMdd.

getToken

public java.lang.String getToken()

Get the token for which snapshot was initiated.

Returns:

snapshot token.

getStart

public java.util.Date getStart()

Get the start date on which snapshot was initiated.

Returns:

start date of snapshot.

getCompleted

public java.util.Date getCompleted()

Get the date on which snapshot was marked as finished/failed etc.

Returns:

completion date of snapshot.

getStatus

public Status getStatus()

Get the status of the snapshot.

Returns:

snapshot status

setCompleted

public void setCompleted(java.util.Date completed)

Set the completion date of snashot status.

Parameters:

completed - date of completion for a snapshot.

setStatus

public void setStatus(Status status)

Set the status of the snapshot.

Parameters:

status - of the snapshot.

getSnapshotLocation

public java.lang.String getSnapshotLocation()

Get the snapshot location where snapshot is uploaded.

Returns:

snapshot upload location for the meta file.

setSnapshotLocation

public void setSnapshotLocation(java.lang.String snapshotLocation)

Set the snapshot location where snapshot is uploaded.

Parameters:

snapshotLocation - where snapshot meta file is uploaded.

isCassandraSnapshotSuccess

public boolean isCassandraSnapshotSuccess()

Find if cassandra snapshot was successful or not. This is a JMX operation and it is possible that this operation failed.

Returns:

cassandra snapshot status.

setCassandraSnapshotSuccess

public void setCassandraSnapshotSuccess(boolean cassandraSnapshotSuccess)

Set the cassandra snapshot status to be either finished successfully or fail.

Parameters:

cassandraSnapshotSuccess - is set to success if JMX operation for snapshot is successful.

getBackupVersion

public BackupVersion getBackupVersion()

Get the backup version for the snapshot.

Returns:

backup version of the snapshot.

getLastValidated

public java.util.Date getLastValidated()

Return the last validation timestamp of this backup metadata. Validation of backup implies finding if all the files are successfully stored in remote file system.

Returns:

date of last backup validation.

setLastValidated

public void setLastValidated(java.util.Date lastValidated)

Set the last validation date of backup metadata.

Parameters:

lastValidated - date value of backup validation.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object