Class CategoricalScore.Builder

java.lang.Object

com.ants.platform.client.resources.commons.types.CategoricalScore.Builder

All Implemented Interfaces:

CategoricalScore._FinalStage, CategoricalScore.CreatedAtStage, CategoricalScore.IdStage, CategoricalScore.NameStage, CategoricalScore.SourceStage, CategoricalScore.StringValueStage, CategoricalScore.TimestampStage, CategoricalScore.UpdatedAtStage

Enclosing class:

CategoricalScore

public static final class CategoricalScore.Builder
extends Object
implements CategoricalScore.StringValueStage, CategoricalScore.IdStage, CategoricalScore.NameStage, CategoricalScore.SourceStage, CategoricalScore.TimestampStage, CategoricalScore.CreatedAtStage, CategoricalScore.UpdatedAtStage, CategoricalScore._FinalStage

Method Summary

Modifier and Type	Method	Description
CategoricalScore._FinalStage	authorUserId(String authorUserId)
CategoricalScore._FinalStage	authorUserId(Optional<String> authorUserId)
CategoricalScore	build()
CategoricalScore._FinalStage	comment(String comment)
CategoricalScore._FinalStage	comment(Optional<String> comment)
CategoricalScore._FinalStage	configId(String configId)	Reference a score config on a score.
CategoricalScore._FinalStage	configId(Optional<String> configId)
CategoricalScore.UpdatedAtStage	createdAt(OffsetDateTime createdAt)
CategoricalScore._FinalStage	datasetRunId(String datasetRunId)
CategoricalScore._FinalStage	datasetRunId(Optional<String> datasetRunId)
CategoricalScore._FinalStage	environment(String environment)	The environment from which this score originated.
CategoricalScore._FinalStage	environment(Optional<String> environment)
CategoricalScore.Builder	from(CategoricalScore other)
CategoricalScore.NameStage	id(String id)
CategoricalScore._FinalStage	metadata(Object metadata)
CategoricalScore._FinalStage	metadata(Optional<Object> metadata)
CategoricalScore.SourceStage	name(String name)
CategoricalScore._FinalStage	observationId(String observationId)
CategoricalScore._FinalStage	observationId(Optional<String> observationId)
CategoricalScore._FinalStage	queueId(String queueId)	Reference an annotation queue on a score.
CategoricalScore._FinalStage	queueId(Optional<String> queueId)
CategoricalScore._FinalStage	sessionId(String sessionId)
CategoricalScore._FinalStage	sessionId(Optional<String> sessionId)
CategoricalScore.TimestampStage	source(ScoreSource source)
CategoricalScore.IdStage	stringValue(String stringValue)	The string representation of the score value.
CategoricalScore.CreatedAtStage	timestamp(OffsetDateTime timestamp)
CategoricalScore._FinalStage	traceId(String traceId)
CategoricalScore._FinalStage	traceId(Optional<String> traceId)
CategoricalScore._FinalStage	updatedAt(OffsetDateTime updatedAt)
CategoricalScore._FinalStage	value(Double value)	Only defined if a config is linked.
CategoricalScore._FinalStage	value(Optional<Double> value)

Methods inherited from class java.lang.Object

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

Method Details

from

public CategoricalScore.Builder from(CategoricalScore other)

Specified by:

from in interface CategoricalScore.StringValueStage

stringValue

public CategoricalScore.IdStage stringValue(@NotNull
 String stringValue)

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

Specified by:

stringValue in interface CategoricalScore.StringValueStage

Returns:

Reference to this so that method calls can be chained together.

id

public CategoricalScore.NameStage id(@NotNull
 String id)

Specified by:

id in interface CategoricalScore.IdStage

name

public CategoricalScore.SourceStage name(@NotNull
 String name)

Specified by:

name in interface CategoricalScore.NameStage

source

public CategoricalScore.TimestampStage source(@NotNull
 ScoreSource source)

Specified by:

source in interface CategoricalScore.SourceStage

timestamp

public CategoricalScore.CreatedAtStage timestamp(@NotNull
 OffsetDateTime timestamp)

Specified by:

timestamp in interface CategoricalScore.TimestampStage

createdAt

public CategoricalScore.UpdatedAtStage createdAt(@NotNull
 OffsetDateTime createdAt)

Specified by:

createdAt in interface CategoricalScore.CreatedAtStage

updatedAt

public CategoricalScore._FinalStage updatedAt(@NotNull
 OffsetDateTime updatedAt)

Specified by:

updatedAt in interface CategoricalScore.UpdatedAtStage

environment

public CategoricalScore._FinalStage environment(String environment)

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

Specified by:

environment in interface CategoricalScore._FinalStage

Returns:

Reference to this so that method calls can be chained together.

environment

public CategoricalScore._FinalStage environment(Optional<String> environment)

Specified by:

environment in interface CategoricalScore._FinalStage

queueId

public CategoricalScore._FinalStage queueId(String queueId)

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

Specified by:

queueId in interface CategoricalScore._FinalStage

Returns:

Reference to this so that method calls can be chained together.

queueId

public CategoricalScore._FinalStage queueId(Optional<String> queueId)

Specified by:

queueId in interface CategoricalScore._FinalStage

configId

public CategoricalScore._FinalStage configId(String configId)

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

Specified by:

configId in interface CategoricalScore._FinalStage

Returns:

Reference to this so that method calls can be chained together.

configId

public CategoricalScore._FinalStage configId(Optional<String> configId)

Specified by:

configId in interface CategoricalScore._FinalStage

metadata

public CategoricalScore._FinalStage metadata(Object metadata)

Specified by:

metadata in interface CategoricalScore._FinalStage

metadata

public CategoricalScore._FinalStage metadata(Optional<Object> metadata)

Specified by:

metadata in interface CategoricalScore._FinalStage

comment

public CategoricalScore._FinalStage comment(String comment)

Specified by:

comment in interface CategoricalScore._FinalStage

comment

public CategoricalScore._FinalStage comment(Optional<String> comment)

Specified by:

comment in interface CategoricalScore._FinalStage

authorUserId

public CategoricalScore._FinalStage authorUserId(String authorUserId)

Specified by:

authorUserId in interface CategoricalScore._FinalStage

authorUserId

public CategoricalScore._FinalStage authorUserId(Optional<String> authorUserId)

Specified by:

authorUserId in interface CategoricalScore._FinalStage

datasetRunId

public CategoricalScore._FinalStage datasetRunId(String datasetRunId)

Specified by:

datasetRunId in interface CategoricalScore._FinalStage

datasetRunId

public CategoricalScore._FinalStage datasetRunId(Optional<String> datasetRunId)

Specified by:

datasetRunId in interface CategoricalScore._FinalStage

observationId

public CategoricalScore._FinalStage observationId(String observationId)

Specified by:

observationId in interface CategoricalScore._FinalStage

observationId

public CategoricalScore._FinalStage observationId(Optional<String> observationId)

Specified by:

observationId in interface CategoricalScore._FinalStage

sessionId

public CategoricalScore._FinalStage sessionId(String sessionId)

Specified by:

sessionId in interface CategoricalScore._FinalStage

sessionId

public CategoricalScore._FinalStage sessionId(Optional<String> sessionId)

Specified by:

sessionId in interface CategoricalScore._FinalStage

traceId

public CategoricalScore._FinalStage traceId(String traceId)

Specified by:

traceId in interface CategoricalScore._FinalStage

traceId

public CategoricalScore._FinalStage traceId(Optional<String> traceId)

Specified by:

traceId in interface CategoricalScore._FinalStage

value

public CategoricalScore._FinalStage value(Double value)

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

Specified by:

value in interface CategoricalScore._FinalStage

Returns:

Reference to this so that method calls can be chained together.

value

public CategoricalScore._FinalStage value(Optional<Double> value)

Specified by:

value in interface CategoricalScore._FinalStage

build

public CategoricalScore build()

Specified by:

build in interface CategoricalScore._FinalStage