Class CreateScoreRequest.Builder

java.lang.Object

com.ants.platform.client.resources.score.types.CreateScoreRequest.Builder

All Implemented Interfaces:

CreateScoreRequest._FinalStage, CreateScoreRequest.NameStage, CreateScoreRequest.ValueStage

Enclosing class:

CreateScoreRequest

public static final class CreateScoreRequest.Builder
extends Object
implements CreateScoreRequest.NameStage, CreateScoreRequest.ValueStage, CreateScoreRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
CreateScoreRequest	build()
CreateScoreRequest._FinalStage	comment(String comment)
CreateScoreRequest._FinalStage	comment(Optional<String> comment)
CreateScoreRequest._FinalStage	configId(String configId)	Reference a score config on a score.
CreateScoreRequest._FinalStage	configId(Optional<String> configId)
CreateScoreRequest._FinalStage	datasetRunId(String datasetRunId)
CreateScoreRequest._FinalStage	datasetRunId(Optional<String> datasetRunId)
CreateScoreRequest._FinalStage	dataType(ScoreDataType dataType)	The data type of the score.
CreateScoreRequest._FinalStage	dataType(Optional<ScoreDataType> dataType)
CreateScoreRequest._FinalStage	environment(String environment)	The environment of the score.
CreateScoreRequest._FinalStage	environment(Optional<String> environment)
CreateScoreRequest.Builder	from(CreateScoreRequest other)
CreateScoreRequest._FinalStage	id(String id)
CreateScoreRequest._FinalStage	id(Optional<String> id)
CreateScoreRequest._FinalStage	metadata(Object metadata)
CreateScoreRequest._FinalStage	metadata(Optional<Object> metadata)
CreateScoreRequest.ValueStage	name(String name)
CreateScoreRequest._FinalStage	observationId(String observationId)
CreateScoreRequest._FinalStage	observationId(Optional<String> observationId)
CreateScoreRequest._FinalStage	sessionId(String sessionId)
CreateScoreRequest._FinalStage	sessionId(Optional<String> sessionId)
CreateScoreRequest._FinalStage	traceId(String traceId)
CreateScoreRequest._FinalStage	traceId(Optional<String> traceId)
CreateScoreRequest._FinalStage	value(CreateScoreValue value)	The value of the score.

Methods inherited from class java.lang.Object

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

Method Details

from

public CreateScoreRequest.Builder from(CreateScoreRequest other)

Specified by:

from in interface CreateScoreRequest.NameStage

name

public CreateScoreRequest.ValueStage name(@NotNull
 String name)

Specified by:

name in interface CreateScoreRequest.NameStage

value

public CreateScoreRequest._FinalStage value(@NotNull
 CreateScoreValue value)

The value of the score. Must be passed as string for categorical scores, and numeric for boolean and numeric scores. Boolean score values must equal either 1 or 0 (true or false)

Specified by:

value in interface CreateScoreRequest.ValueStage

Returns:

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

configId

public CreateScoreRequest._FinalStage configId(String configId)

Reference a score config on a score. The unique ANTS Platform identifier of a score config. When passing this field, the dataType and stringValue fields are automatically populated.

Specified by:

configId in interface CreateScoreRequest._FinalStage

Returns:

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

configId

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

Specified by:

configId in interface CreateScoreRequest._FinalStage

dataType

public CreateScoreRequest._FinalStage dataType(ScoreDataType dataType)

The data type of the score. When passing a configId this field is inferred. Otherwise, this field must be passed or will default to numeric.

Specified by:

dataType in interface CreateScoreRequest._FinalStage

Returns:

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

dataType

public CreateScoreRequest._FinalStage dataType(Optional<ScoreDataType> dataType)

Specified by:

dataType in interface CreateScoreRequest._FinalStage

environment

public CreateScoreRequest._FinalStage environment(String environment)

The environment of the score. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'ants-platform'.

Specified by:

environment in interface CreateScoreRequest._FinalStage

Returns:

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

environment

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

Specified by:

environment in interface CreateScoreRequest._FinalStage

metadata

public CreateScoreRequest._FinalStage metadata(Object metadata)

Specified by:

metadata in interface CreateScoreRequest._FinalStage

metadata

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

Specified by:

metadata in interface CreateScoreRequest._FinalStage

comment

public CreateScoreRequest._FinalStage comment(String comment)

Specified by:

comment in interface CreateScoreRequest._FinalStage

comment

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

Specified by:

comment in interface CreateScoreRequest._FinalStage

datasetRunId

public CreateScoreRequest._FinalStage datasetRunId(String datasetRunId)

Specified by:

datasetRunId in interface CreateScoreRequest._FinalStage

datasetRunId

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

Specified by:

datasetRunId in interface CreateScoreRequest._FinalStage

observationId

public CreateScoreRequest._FinalStage observationId(String observationId)

Specified by:

observationId in interface CreateScoreRequest._FinalStage

observationId

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

Specified by:

observationId in interface CreateScoreRequest._FinalStage

sessionId

public CreateScoreRequest._FinalStage sessionId(String sessionId)

Specified by:

sessionId in interface CreateScoreRequest._FinalStage

sessionId

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

Specified by:

sessionId in interface CreateScoreRequest._FinalStage

traceId

public CreateScoreRequest._FinalStage traceId(String traceId)

Specified by:

traceId in interface CreateScoreRequest._FinalStage

traceId

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

Specified by:

traceId in interface CreateScoreRequest._FinalStage

id

public CreateScoreRequest._FinalStage id(String id)

Specified by:

id in interface CreateScoreRequest._FinalStage

id

public CreateScoreRequest._FinalStage id(Optional<String> id)

Specified by:

id in interface CreateScoreRequest._FinalStage

build

public CreateScoreRequest build()

Specified by:

build in interface CreateScoreRequest._FinalStage