Class TaskStatusValueObject.TaskError

java.lang.Object

ubic.gemma.rest.TaskStatusValueObject.TaskError

Enclosing class:

TaskStatusValueObject

public static class TaskStatusValueObject.TaskError
extends Object

Machine-readable classification of a failed task, so a REST client can react to the failure (link to the existing experiment, correct the accession, retry a transient network error, or surface the raw detail) rather than parsing a free-text message. Present only when TaskStatusValueObject.getStatus() is failed.

Constructor Summary

Constructors

Constructor	Description
TaskError()

Method Summary

Modifier and Type	Method	Description
String	getCode()	Stable, machine-readable code.
String	getExceptionType()	Simple class name of the underlying exception, for diagnostics.
Long	getExistingExperimentId()	For ALREADY_EXISTS, the id of the experiment that already holds the accession, when resolvable.
String	getMessage()	Human-readable description of the failure.
void	setCode(String code)	Stable, machine-readable code.
void	setExceptionType(String exceptionType)	Simple class name of the underlying exception, for diagnostics.
void	setExistingExperimentId(Long existingExperimentId)	For ALREADY_EXISTS, the id of the experiment that already holds the accession, when resolvable.
void	setMessage(String message)	Human-readable description of the failure.

Methods inherited from class Object

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

Constructor Details

TaskError

public TaskError()

Method Details

getCode

public String getCode()

Stable, machine-readable code. Known values:

• ALREADY_EXISTS — the accession is already loaded (see existingExperimentId).
• INVALID_ACCESSION — GEO/ArrayExpress rejected the accession as unknown or malformed.
• NETWORK_ERROR — a fetch from the remote source (e.g. NCBI GEO FTP) failed; usually transient.
• BLACKLISTED — the accession is on Gemma's blacklist and will not be imported.
• SUPERSERIES_NOT_ALLOWED / SUBSERIES_NOT_ALLOWED — a super/sub-series gate blocked the load; retry with the corresponding allow-flag if the load is intended.
• UNSUPPORTED_TAXON — no supported taxon remained after filtering the samples.
• TASK_FAILED — anything else; consult message and the server logs.

getMessage

public String getMessage()

Human-readable description of the failure.

getExceptionType

public String getExceptionType()

Simple class name of the underlying exception, for diagnostics.

getExistingExperimentId

@Nullable
public Long getExistingExperimentId()

For ALREADY_EXISTS, the id of the experiment that already holds the accession, when resolvable.

setCode

public void setCode(String code)

Stable, machine-readable code. Known values:

• ALREADY_EXISTS — the accession is already loaded (see existingExperimentId).
• INVALID_ACCESSION — GEO/ArrayExpress rejected the accession as unknown or malformed.
• NETWORK_ERROR — a fetch from the remote source (e.g. NCBI GEO FTP) failed; usually transient.
• BLACKLISTED — the accession is on Gemma's blacklist and will not be imported.
• SUPERSERIES_NOT_ALLOWED / SUBSERIES_NOT_ALLOWED — a super/sub-series gate blocked the load; retry with the corresponding allow-flag if the load is intended.
• UNSUPPORTED_TAXON — no supported taxon remained after filtering the samples.
• TASK_FAILED — anything else; consult message and the server logs.

setMessage

public void setMessage(String message)

Human-readable description of the failure.

setExceptionType

public void setExceptionType(String exceptionType)

Simple class name of the underlying exception, for diagnostics.

setExistingExperimentId

public void setExistingExperimentId(@Nullable
 Long existingExperimentId)

For ALREADY_EXISTS, the id of the experiment that already holds the accession, when resolvable.