Package com.datarobot.model

Class Status

java.lang.Object

com.datarobot.model.ReturnsLocation

com.datarobot.model.Status

All Implemented Interfaces:

ILocationResponse, java.io.Serializable

public class Status
extends ReturnsLocation
implements java.io.Serializable, ILocationResponse

A reference to the Status object for a task on the DataRobot server. Client code that uses the DataRobot AI API package generally should not construct these objects directly, they should be instantiated by AI API Client methods. This object may be out of sync with the DataRobot sever, for example, if multiple processes or users have permission to modify or delete it on the server.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Status()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)	internal
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()	internal
java.lang.String	getCode()	Get the current status code
org.joda.time.DateTime	getCreatedOn()	Get the DateTime of when the status was created
java.lang.String	getDescription()	Get a description describing details of the current status
java.lang.String	getId()	Get the ID of this Status object
java.net.URI	getLocation()	internal
java.lang.String	getMessage()	Get the message for the current status
java.lang.String	getObjectId()	internal
java.net.URI	getResult()	Get the location of the result of this Status object
java.lang.String	getStatus()	Get the current status of the process
int	getStatusCode()	Get the status code of this Status object
java.lang.String	getStatusId()	The ID of this status object.
java.lang.String	getStatusType()	Get the status type of the current status
int	hashCode()	internal
void	setAdditionalProperty(java.lang.String name, java.lang.Object value)	internal
void	setMessage(java.lang.String message)	internal
void	setObjectId(java.lang.String objectId)	internal
void	setResult(java.lang.String result)	internal
void	setStatus(java.lang.String status)	internal
void	setStatusCode(int statusCode)	internal
void	setStatusId()	internal
void	setStatusId(java.lang.String statusId)	internal
java.lang.String	toString()

Methods inherited from class com.datarobot.model.ReturnsLocation

AssignLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

Status

public Status()

Method Detail

getStatusCode

public int getStatusCode()

Get the status code of this Status object

Specified by:

getStatusCode in interface ILocationResponse

Returns:

the status code

getId

public java.lang.String getId()

Get the ID of this Status object

Returns:

the status ID

getResult

public java.net.URI getResult()

Get the location of the result of this Status object

Returns:

the URI of the result

getStatusId

public java.lang.String getStatusId()

The ID of this status object.

Specified by:

getStatusId in interface ILocationResponse

Returns:

An ID used to refer to this status object.

getStatus

public java.lang.String getStatus()

Get the current status of the process

Returns:

The current status indicating what step a process is currently in

getCode

public java.lang.String getCode()

Get the current status code

Returns:

the status code

getDescription

public java.lang.String getDescription()

Get a description describing details of the current status

Returns:

a description of the current status

getCreatedOn

public org.joda.time.DateTime getCreatedOn()

Get the DateTime of when the status was created

Returns:

DateTime of when the status was created

getMessage

public java.lang.String getMessage()

Get the message for the current status

Returns:

the message for the current status

getStatusType

public java.lang.String getStatusType()

Get the status type of the current status

Returns:

the status type

getLocation

public java.net.URI getLocation()

internal

Specified by:

getLocation in interface ILocationResponse

Overrides:

getLocation in class ReturnsLocation

setStatusId

public void setStatusId()

internal

Specified by:

setStatusId in interface ILocationResponse

setResult

public void setResult(java.lang.String result)

internal

getObjectId

public java.lang.String getObjectId()

internal

Specified by:

getObjectId in interface ILocationResponse

setObjectId

public void setObjectId(java.lang.String objectId)

internal

Specified by:

setObjectId in interface ILocationResponse

setStatus

public void setStatus(java.lang.String status)

internal

setMessage

public void setMessage(java.lang.String message)

internal

setStatusCode

public void setStatusCode(int statusCode)

internal

Specified by:

setStatusCode in interface ILocationResponse

setStatusId

public void setStatusId(java.lang.String statusId)

internal

setAdditionalProperty

public void setAdditionalProperty(java.lang.String name,
                                  java.lang.Object value)

internal

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

internal

hashCode

public int hashCode()

internal

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

internal

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object