Package com.datarobot.impl

Class StatusClient

java.lang.Object

com.datarobot.impl.StatusClient

All Implemented Interfaces:

IStatusClient

public class StatusClient
extends java.lang.Object
implements IStatusClient

The StatusClient object provides access to the status endpoints of the DataRobot AI API. This object is not meant to be used directly but through the DataRobotAIClient.status() method.

Constructor Summary

Constructors

Constructor	Description
StatusClient(IDataRobotAIClient client)	IStatusClient based API operations.

Method Summary

Modifier and Type	Method	Description
Status	get(java.lang.String statusId)	Get a status object by ID
Action<com.google.api.client.http.HttpRequest,com.google.api.client.http.HttpResponse>	getHttpMessageTransformer()	internal
StatusList	list()	A list with status information on all StatusTask currently running for this account
StatusList	list(PagingParams params)	A list with status information on all StatusTask currently running for this account
void	setHttpMessageTransformer(Action<com.google.api.client.http.HttpRequest,com.google.api.client.http.HttpResponse> httpMessageTransformer)	internal
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusClient

public StatusClient(IDataRobotAIClient client)

IStatusClient based API operations. Users will not need to instantiate this object directly. It can be accessed through DataRobotAIClient.status().

Parameters:

client - DataRobotAIClient

Method Detail

getHttpMessageTransformer

public Action<com.google.api.client.http.HttpRequest,com.google.api.client.http.HttpResponse> getHttpMessageTransformer()

internal

Specified by:

getHttpMessageTransformer in interface IStatusClient

setHttpMessageTransformer

public void setHttpMessageTransformer(Action<com.google.api.client.http.HttpRequest,com.google.api.client.http.HttpResponse> httpMessageTransformer)

internal

Specified by:

setHttpMessageTransformer in interface IStatusClient

list

public StatusList list()
                throws ClientException

A list with status information on all StatusTask currently running for this account

Specified by:

list in interface IStatusClient

Returns:

StatusList

Throws:

ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

list

public StatusList list(PagingParams params)
                throws ClientException

A list with status information on all StatusTask currently running for this account

Specified by:

list in interface IStatusClient

Parameters:

params - The PagingParams object for this list

Returns:

StatusList

Throws:

ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

get

public Status get(java.lang.String statusId)
           throws ClientException

Get a status object by ID

Specified by:

get in interface IStatusClient

Parameters:

statusId - The ID of the Status

Returns:

The queried Status object

Throws:

ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object