Package alluxio.job.wire

Class PlanInfo

java.lang.Object

alluxio.job.wire.PlanInfo

All Implemented Interfaces:

JobInfo

public final class PlanInfo
extends java.lang.Object
implements JobInfo

The plan description.

Constructor Summary

Constructors

Constructor	Description
PlanInfo(long id, java.lang.String name, Status status, long lastUpdated, java.lang.String errorMessage)	JobInfo constructor exposed for testing.
PlanInfo(alluxio.grpc.JobInfo jobInfo)	Constructs a new instance of PlanInfo from a proto object.
PlanInfo(PlanInfo planInfo, boolean verbose)	Constructs the plan info from the job master's internal representation of job info.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.util.List<java.lang.String>	getAffectedPaths()
java.util.List<JobInfo>	getChildren()
java.lang.String	getDescription()
java.lang.String	getErrorMessage()
java.lang.String	getErrorType()
long	getId()
long	getLastUpdated()
java.lang.String	getName()
java.lang.Long	getParentId()
java.lang.String	getResult()
Status	getStatus()
int	hashCode()
alluxio.grpc.JobInfo	toProto()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanInfo

public PlanInfo(long id,
                java.lang.String name,
                Status status,
                long lastUpdated,
                @Nullable
                java.lang.String errorMessage)

JobInfo constructor exposed for testing.

Parameters:

id - job id

name - name of the job

status - job status

lastUpdated - last updated time in milliseconds

errorMessage - job error message

PlanInfo

public PlanInfo(PlanInfo planInfo,
                boolean verbose)

Constructs the plan info from the job master's internal representation of job info.

Parameters:

planInfo - the job master's internal job info

verbose - whether the representation should be verbose

PlanInfo

public PlanInfo(alluxio.grpc.JobInfo jobInfo)
         throws java.io.IOException

Constructs a new instance of PlanInfo from a proto object.

Parameters:

jobInfo - the proto object

Throws:

java.io.IOException - if the deserialization fails

Method Detail

getParentId

public java.lang.Long getParentId()

Specified by:

getParentId in interface JobInfo

Returns:

parent job id

getId

public long getId()

Specified by:

getId in interface JobInfo

Returns:

job id

getName

public java.lang.String getName()

Specified by:

getName in interface JobInfo

Returns:

name of the job

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface JobInfo

Returns:

description of the job

getResult

public java.lang.String getResult()

Specified by:

getResult in interface JobInfo

Returns:

result of the job

getStatus

public Status getStatus()

Specified by:

getStatus in interface JobInfo

Returns:

status of the job

getChildren

public java.util.List<JobInfo> getChildren()

Specified by:

getChildren in interface JobInfo

Returns:

collection of children

getErrorType

public java.lang.String getErrorType()

Specified by:

getErrorType in interface JobInfo

Returns:

the error type

getErrorMessage

public java.lang.String getErrorMessage()

Specified by:

getErrorMessage in interface JobInfo

Returns:

error message

getLastUpdated

public long getLastUpdated()

Specified by:

getLastUpdated in interface JobInfo

Returns:

last updated time in milliseconds

getAffectedPaths

public java.util.List<java.lang.String> getAffectedPaths()

Specified by:

getAffectedPaths in interface JobInfo

Returns:

a list of affected alluxio paths by this plan

toProto

public alluxio.grpc.JobInfo toProto()
                             throws java.io.IOException

Specified by:

toProto in interface JobInfo

Returns:

proto representation of the job info

Throws:

java.io.IOException - if serialization fails

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object