Class CategoricalScoreV1

java.lang.Object

com.ants.platform.client.resources.commons.types.CategoricalScoreV1

All Implemented Interfaces:

IBaseScoreV1

public final class CategoricalScoreV1
extends Object
implements IBaseScoreV1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CategoricalScoreV1._FinalStage
static final class	CategoricalScoreV1.Builder
static interface	CategoricalScoreV1.CreatedAtStage
static interface	CategoricalScoreV1.IdStage
static interface	CategoricalScoreV1.NameStage
static interface	CategoricalScoreV1.SourceStage
static interface	CategoricalScoreV1.StringValueStage
static interface	CategoricalScoreV1.TimestampStage
static interface	CategoricalScoreV1.TraceIdStage
static interface	CategoricalScoreV1.UpdatedAtStage

Method Summary

Modifier and Type	Method	Description
static CategoricalScoreV1.IdStage	builder()
boolean	equals(Object other)
Map<String,Object>	getAdditionalProperties()
Optional<String>	getAuthorUserId()
Optional<String>	getComment()
Optional<String>	getConfigId()
OffsetDateTime	getCreatedAt()
Optional<String>	getEnvironment()
String	getId()
Optional<Object>	getMetadata()
String	getName()
Optional<String>	getObservationId()
Optional<String>	getQueueId()
ScoreSource	getSource()
String	getStringValue()
OffsetDateTime	getTimestamp()
String	getTraceId()
OffsetDateTime	getUpdatedAt()
Optional<Double>	getValue()
int	hashCode()
String	toString()

Methods inherited from class Object

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

Method Details

getId

public String getId()

Specified by:

getId in interface IBaseScoreV1

getTraceId

public String getTraceId()

Specified by:

getTraceId in interface IBaseScoreV1

getName

public String getName()

Specified by:

getName in interface IBaseScoreV1

getSource

public ScoreSource getSource()

Specified by:

getSource in interface IBaseScoreV1

getObservationId

public Optional<String> getObservationId()

Specified by:

getObservationId in interface IBaseScoreV1

getTimestamp

public OffsetDateTime getTimestamp()

Specified by:

getTimestamp in interface IBaseScoreV1

getCreatedAt

public OffsetDateTime getCreatedAt()

Specified by:

getCreatedAt in interface IBaseScoreV1

getUpdatedAt

public OffsetDateTime getUpdatedAt()

Specified by:

getUpdatedAt in interface IBaseScoreV1

getAuthorUserId

public Optional<String> getAuthorUserId()

Specified by:

getAuthorUserId in interface IBaseScoreV1

getComment

public Optional<String> getComment()

Specified by:

getComment in interface IBaseScoreV1

getMetadata

public Optional<Object> getMetadata()

Specified by:

getMetadata in interface IBaseScoreV1

getConfigId

public Optional<String> getConfigId()

Specified by:

getConfigId in interface IBaseScoreV1

Returns:

Reference a score config on a score. When set, config and score name must be equal and value must comply to optionally defined numerical range

getQueueId

public Optional<String> getQueueId()

Specified by:

getQueueId in interface IBaseScoreV1

Returns:

Reference an annotation queue on a score. Populated if the score was initially created in an annotation queue.

getEnvironment

public Optional<String> getEnvironment()

Specified by:

getEnvironment in interface IBaseScoreV1

Returns:

The environment from which this score originated. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'ants-platform'.

getValue

public Optional<Double> getValue()

Returns:

Only defined if a config is linked. Represents the numeric category mapping of the stringValue

getStringValue

public String getStringValue()

Returns:

The string representation of the score value. If no config is linked, can be any string. Otherwise, must map to a config category

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static CategoricalScoreV1.IdStage builder()