com.cloudera.api.model
Class ApiHdfsReplicationResult

java.lang.Object
  com.cloudera.api.model.ApiHdfsReplicationResult

public class ApiHdfsReplicationResult
extends Object

Detailed information about an HDFS replication job.

Constructor Summary

ApiHdfsReplicationResult()

Method Summary

boolean	equals(Object o)
List<ApiHdfsReplicationCounter>	getCounters() The counters collected from the replication job.
Date	getEstimatedCompletionTime() The estimated completion time for the mapper phase.
List<String>	getFailedFiles() The list of files that failed during replication.
String	getJobDetailsUri() Read-only.
String	getJobId() Read-only.
long	getNumBytesCopied() The number of bytes actually copied.
long	getNumBytesCopyFailed() The aggregate number of bytes in the files for which copy failed.
long	getNumBytesDryRun() The number of bytes found to copy.
long	getNumBytesExpected() The number of bytes expected to be copied.
long	getNumBytesSkipped() The aggregate number of bytes in the skipped files.
long	getNumFilesCopied() The number of files actually copied.
long	getNumFilesCopyFailed() The number of files for which copy failed.
long	getNumFilesDeleted() The number of files deleted since they were present at destination, but missing from source.
long	getNumFilesDryRun() The number of files found to copy.
long	getNumFilesExpected() The number of files expected to be copied.
long	getNumFilesSkipped() The number of files that were unchanged and thus skipped during copying.
int	getProgress() The file copy progress percentage.
int	getRemainingTime() The time remaining for mapper phase (seconds).
String	getRunAsUser() Returns run-as user name.
String	getRunOnSourceAsUser() Returns run-as user name for source cluster.
String	getSetupError() The error that happened during job setup, if any.
List<String>	getSnapshottedDirs() The list of directories for which snapshots were taken and used as part of this replication.
double	getThroughput() The data throughput in KB/s.
int	hashCode()
boolean	isDryRun() Whether this was a dry run.
void	setCounters(List<ApiHdfsReplicationCounter> counters)
void	setDryRun(boolean dryRun)
void	setEstimatedCompletionTime(Date estimatedCompletionTime)
void	setFailedFiles(List<String> failedFiles)
void	setJobDetailsUri(String jobDetailsUri)
void	setJobId(String jobId)
void	setNumBytesCopied(long numBytesCopied)
void	setNumBytesCopyFailed(long numBytesCopyFailed)
void	setNumBytesDryRun(long numBytesDryRun)
void	setNumBytesExpected(long numBytesExpected)
void	setNumBytesSkipped(long numBytesSkipped)
void	setNumFilesCopied(long numFiledCopied)
void	setNumFilesCopyFailed(long numFilesCopyFailed)
void	setNumFilesDeleted(long numFilesDeleted)
void	setNumFilesDryRun(long numFilesDryRun)
void	setNumFilesExpected(long numFiledExpected)
void	setNumFilesSkipped(long numFilesSkipped)
void	setProgress(int progress)
void	setRemainingTime(int remainingTime)
void	setRunAsUser(String runAsUser)
void	setRunOnSourceAsUser(String runOnSourceAsUser)
void	setSetupError(String setupError)
void	setSnapshottedDirs(List<String> snapshottedDirs)
void	setThroughput(double througput)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiHdfsReplicationResult

public ApiHdfsReplicationResult()

Method Detail

getProgress

public int getProgress()

The file copy progress percentage.

setProgress

public void setProgress(int progress)

getThroughput

public double getThroughput()

The data throughput in KB/s.

setThroughput

public void setThroughput(double througput)

getRemainingTime

public int getRemainingTime()

The time remaining for mapper phase (seconds).

setRemainingTime

public void setRemainingTime(int remainingTime)

getEstimatedCompletionTime

public Date getEstimatedCompletionTime()

The estimated completion time for the mapper phase.

setEstimatedCompletionTime

public void setEstimatedCompletionTime(Date estimatedCompletionTime)

getCounters

public List<ApiHdfsReplicationCounter> getCounters()

The counters collected from the replication job.

Starting with API v4, the full list of counters is only available in the full view.

setCounters

public void setCounters(List<ApiHdfsReplicationCounter> counters)

getNumFilesDryRun

public long getNumFilesDryRun()

The number of files found to copy.

setNumFilesDryRun

public void setNumFilesDryRun(long numFilesDryRun)

getNumBytesDryRun

public long getNumBytesDryRun()

The number of bytes found to copy.

setNumBytesDryRun

public void setNumBytesDryRun(long numBytesDryRun)

getNumFilesExpected

public long getNumFilesExpected()

The number of files expected to be copied.

setNumFilesExpected

public void setNumFilesExpected(long numFiledExpected)

getNumBytesExpected

public long getNumBytesExpected()

The number of bytes expected to be copied.

setNumBytesExpected

public void setNumBytesExpected(long numBytesExpected)

getNumFilesCopied

public long getNumFilesCopied()

The number of files actually copied.

setNumFilesCopied

public void setNumFilesCopied(long numFiledCopied)

getNumBytesCopied

public long getNumBytesCopied()

The number of bytes actually copied.

setNumBytesCopied

public void setNumBytesCopied(long numBytesCopied)

getNumFilesSkipped

public long getNumFilesSkipped()

The number of files that were unchanged and thus skipped during copying.

setNumFilesSkipped

public void setNumFilesSkipped(long numFilesSkipped)

getNumBytesSkipped

public long getNumBytesSkipped()

The aggregate number of bytes in the skipped files.

setNumBytesSkipped

public void setNumBytesSkipped(long numBytesSkipped)

getNumFilesDeleted

public long getNumFilesDeleted()

The number of files deleted since they were present at destination, but missing from source.

setNumFilesDeleted

public void setNumFilesDeleted(long numFilesDeleted)

getNumFilesCopyFailed

public long getNumFilesCopyFailed()

The number of files for which copy failed.

setNumFilesCopyFailed

public void setNumFilesCopyFailed(long numFilesCopyFailed)

getNumBytesCopyFailed

public long getNumBytesCopyFailed()

The aggregate number of bytes in the files for which copy failed.

setNumBytesCopyFailed

public void setNumBytesCopyFailed(long numBytesCopyFailed)

getSetupError

public String getSetupError()

The error that happened during job setup, if any.

setSetupError

public void setSetupError(String setupError)

getJobId

public String getJobId()

Read-only. The MapReduce job ID for the replication job. Available since API v4.

This can be used to query information about the replication job from the MapReduce server where it was executed. Refer to the "/activities" resource for services for further details.

setJobId

public void setJobId(String jobId)

getJobDetailsUri

public String getJobDetailsUri()

Read-only. The URI (relative to the CM server's root) where to find the Activity Monitor page for the job. Available since API v4.

setJobDetailsUri

public void setJobDetailsUri(String jobDetailsUri)

isDryRun

public boolean isDryRun()

Whether this was a dry run.

setDryRun

public void setDryRun(boolean dryRun)

getSnapshottedDirs

public List<String> getSnapshottedDirs()

The list of directories for which snapshots were taken and used as part of this replication.

setSnapshottedDirs

public void setSnapshottedDirs(List<String> snapshottedDirs)

getRunAsUser

public String getRunAsUser()

Returns run-as user name. Available since API v11.

setRunAsUser

public void setRunAsUser(String runAsUser)

getRunOnSourceAsUser

public String getRunOnSourceAsUser()

Returns run-as user name for source cluster. Available since API v18.

setRunOnSourceAsUser

public void setRunOnSourceAsUser(String runOnSourceAsUser)

getFailedFiles

public List<String> getFailedFiles()

The list of files that failed during replication. Available since API v11.

setFailedFiles

public void setFailedFiles(List<String> failedFiles)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object