edu.ksu.canvas.model

Class Progress

java.lang.Object

edu.ksu.canvas.model.Progress

All Implemented Interfaces:

Serializable

public class Progress
extends Object
implements Serializable

API for querying the progress of asynchronous API operations. id: the ID of the Progress object contextId the context owning the job. userId the id of the user who started the job tag the type of operation completion percent completed workflowState the state of the job one of 'queued', 'running', 'completed', 'failed' createdAt the time the job was created updatedAt the time the job was last updated message optional details about the job url url where a progress update can be retrieved

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Progress()

Method Summary

Modifier and Type	Method and Description
Double	getCompletion()
Integer	getContextId()
String	getContextType()
Date	getCreatedAt()
Integer	getId()
String	getMessage()
String	getTag()
Date	getUpdatedAt()
String	getUrl()
Integer	getUserId()
String	getWorkflowState()
void	setCompletion(Double completion)
void	setContextId(Integer contextId)
void	setContextType(String contextType)
void	setCreatedAt(Date createdAt)
void	setId(Integer id)
void	setMessage(String message)
void	setTag(String tag)
void	setUpdatedAt(Date updatedAt)
void	setUrl(String url)
void	setUserId(Integer userId)
void	setWorkflowState(String workflowState)

Methods inherited from class java.lang.Object

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

Constructor Detail

Progress

public Progress()

Method Detail

getId

public Integer getId()

setId

public void setId(Integer id)

getContextId

public Integer getContextId()

setContextId

public void setContextId(Integer contextId)

getContextType

public String getContextType()

setContextType

public void setContextType(String contextType)

getUserId

public Integer getUserId()

setUserId

public void setUserId(Integer userId)

getTag

public String getTag()

setTag

public void setTag(String tag)

getCompletion

public Double getCompletion()

setCompletion

public void setCompletion(Double completion)

getWorkflowState

public String getWorkflowState()

setWorkflowState

public void setWorkflowState(String workflowState)

getUpdatedAt

public Date getUpdatedAt()

setUpdatedAt

public void setUpdatedAt(Date updatedAt)

getCreatedAt

public Date getCreatedAt()

setCreatedAt

public void setCreatedAt(Date createdAt)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

getUrl

public String getUrl()

setUrl

public void setUrl(String url)