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

Class CategoricalScoreV1.Builder

java.lang.Object

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

All Implemented Interfaces:

CategoricalScoreV1._FinalStage, CategoricalScoreV1.CreatedAtStage, CategoricalScoreV1.IdStage, CategoricalScoreV1.NameStage, CategoricalScoreV1.SourceStage, CategoricalScoreV1.StringValueStage, CategoricalScoreV1.TimestampStage, CategoricalScoreV1.TraceIdStage, CategoricalScoreV1.UpdatedAtStage

Enclosing class:

CategoricalScoreV1

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

Method Summary

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

Specified by:

from in interface CategoricalScoreV1.IdStage

id

public CategoricalScoreV1.TraceIdStage id(@NotNull
 String id)

Specified by:

id in interface CategoricalScoreV1.IdStage

traceId

public CategoricalScoreV1.NameStage traceId(@NotNull
 String traceId)

Specified by:

traceId in interface CategoricalScoreV1.TraceIdStage

name

public CategoricalScoreV1.SourceStage name(@NotNull
 String name)

Specified by:

name in interface CategoricalScoreV1.NameStage

source

public CategoricalScoreV1.TimestampStage source(@NotNull
 ScoreSource source)

Specified by:

source in interface CategoricalScoreV1.SourceStage

timestamp

public CategoricalScoreV1.CreatedAtStage timestamp(@NotNull
 OffsetDateTime timestamp)

Specified by:

timestamp in interface CategoricalScoreV1.TimestampStage

createdAt

public CategoricalScoreV1.UpdatedAtStage createdAt(@NotNull
 OffsetDateTime createdAt)

Specified by:

createdAt in interface CategoricalScoreV1.CreatedAtStage

updatedAt

public CategoricalScoreV1.StringValueStage updatedAt(@NotNull
 OffsetDateTime updatedAt)

Specified by:

updatedAt in interface CategoricalScoreV1.UpdatedAtStage

stringValue

public CategoricalScoreV1._FinalStage 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 CategoricalScoreV1.StringValueStage

Returns:

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

value

public CategoricalScoreV1._FinalStage value(Double value)

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

Specified by:

value in interface CategoricalScoreV1._FinalStage

Returns:

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

value

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

Specified by:

value in interface CategoricalScoreV1._FinalStage

environment

public CategoricalScoreV1._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 CategoricalScoreV1._FinalStage

Returns:

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

environment

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

Specified by:

environment in interface CategoricalScoreV1._FinalStage

queueId

public CategoricalScoreV1._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 CategoricalScoreV1._FinalStage

Returns:

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

queueId

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

Specified by:

queueId in interface CategoricalScoreV1._FinalStage

configId

public CategoricalScoreV1._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 CategoricalScoreV1._FinalStage

Returns:

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

configId

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

Specified by:

configId in interface CategoricalScoreV1._FinalStage

metadata

public CategoricalScoreV1._FinalStage metadata(Object metadata)

Specified by:

metadata in interface CategoricalScoreV1._FinalStage

metadata

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

Specified by:

metadata in interface CategoricalScoreV1._FinalStage

comment

public CategoricalScoreV1._FinalStage comment(String comment)

Specified by:

comment in interface CategoricalScoreV1._FinalStage

comment

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

Specified by:

comment in interface CategoricalScoreV1._FinalStage

authorUserId

public CategoricalScoreV1._FinalStage authorUserId(String authorUserId)

Specified by:

authorUserId in interface CategoricalScoreV1._FinalStage

authorUserId

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

Specified by:

authorUserId in interface CategoricalScoreV1._FinalStage

observationId

public CategoricalScoreV1._FinalStage observationId(String observationId)

Specified by:

observationId in interface CategoricalScoreV1._FinalStage

observationId

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

Specified by:

observationId in interface CategoricalScoreV1._FinalStage

build

public CategoricalScoreV1 build()

Specified by:

build in interface CategoricalScoreV1._FinalStage