org.jclouds.cloudstack.domain
Class AsyncJob<S>

java.lang.Object
  org.jclouds.cloudstack.domain.AsyncJob<S>

public class AsyncJob<S>
extends Object

Class AsyncJob

Author:

Adrian Cole

Nested Class Summary

static class	AsyncJob.Builder<T extends AsyncJob.Builder<T,S>,S>
static class	AsyncJob.ResultCode Valid job result codes
static class	AsyncJob.Status Valid async job statuses

Constructor Summary

protected

AsyncJob(String accountId, String cmd, Date created, String id, String instanceId, String instanceType, int progress, S result, AsyncJob.ResultCode resultCode, String resultType, AsyncJob.Status status, String userId, AsyncJobError error)

Method Summary

static <T> AsyncJob.Builder<?,T>	builder()
boolean	equals(Object obj)
String	getAccountId()
String	getCmd()
Date	getCreated()
AsyncJobError	getError()
String	getId()
String	getInstanceId()
String	getInstanceType()
int	getProgress()
S	getResult()
AsyncJob.ResultCode	getResultCode()
String	getResultType()
AsyncJob.Status	getStatus()
String	getUserId()
boolean	hasFailed()
int	hashCode()
boolean	hasSucceed()
protected com.google.common.base.Objects.ToStringHelper	string()
AsyncJob.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncJob

@ConstructorProperties(value={"accountid","cmd","created","jobid","jobinstanceid","jobinstancetype","jobprocstatus","jobresult","jobresultcode","jobresulttype","jobstatus","userid","error"})
protected AsyncJob(@Nullable
                                              String accountId,
                                              @Nullable
                                              String cmd,
                                              @Nullable
                                              Date created,
                                              String id,
                                              @Nullable
                                              String instanceId,
                                              @Nullable
                                              String instanceType,
                                              int progress,
                                              @Nullable
                                              S result,
                                              @Nullable
                                              AsyncJob.ResultCode resultCode,
                                              @Nullable
                                              String resultType,
                                              @Nullable
                                              AsyncJob.Status status,
                                              @Nullable
                                              String userId,
                                              @Nullable
                                              AsyncJobError error)

Method Detail

builder

public static <T> AsyncJob.Builder<?,T> builder()

toBuilder

public AsyncJob.Builder toBuilder()

getAccountId

@Nullable
public String getAccountId()

Returns:

the account that executed the async command

getCmd

@Nullable
public String getCmd()

Returns:

the async command executed

getCreated

@Nullable
public Date getCreated()

Returns:

the created date of the job

getId

public String getId()

Returns:

async job ID

getInstanceId

@Nullable
public String getInstanceId()

Returns:

the unique ID of the instance/entity object related to the job

getInstanceType

@Nullable
public String getInstanceType()

Returns:

the instance/entity object related to the job

getProgress

public int getProgress()

Returns:

the progress information of the PENDING job

getResult

@Nullable
public S getResult()

Returns:

the result reason

getResultCode

@Nullable
public AsyncJob.ResultCode getResultCode()

Returns:

the result code for the job

getResultType

@Nullable
public String getResultType()

Returns:

the result type

getStatus

@Nullable
public AsyncJob.Status getStatus()

Returns:

the current job status-should be 0 for PENDING

getUserId

@Nullable
public String getUserId()

Returns:

the user that executed the async command

getError

@Nullable
public AsyncJobError getError()

Returns:

the error related to this command, or null if no error or error not yet encountered.

hasFailed

public boolean hasFailed()

hasSucceed

public boolean hasSucceed()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

string

protected com.google.common.base.Objects.ToStringHelper string()

toString

public String toString()

Overrides:

toString in class Object