Class Observation.Builder

java.lang.Object

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

All Implemented Interfaces:

Observation._FinalStage, Observation.IdStage, Observation.LevelStage, Observation.StartTimeStage, Observation.TypeStage

Enclosing class:

Observation

public static final class Observation.Builder
extends Object
implements Observation.IdStage, Observation.TypeStage, Observation.StartTimeStage, Observation.LevelStage, Observation._FinalStage

Method Summary

Modifier and Type	Method	Description
Observation	build()
Observation._FinalStage	completionStartTime(OffsetDateTime completionStartTime)	The completion start time of the observation
Observation._FinalStage	completionStartTime(Optional<OffsetDateTime> completionStartTime)
Observation._FinalStage	costDetails(Map<String,Double> costDetails)	The cost details of the observation.
Observation._FinalStage	costDetails(Optional<Map<String,Double>> costDetails)
Observation._FinalStage	endTime(OffsetDateTime endTime)	The end time of the observation.
Observation._FinalStage	endTime(Optional<OffsetDateTime> endTime)
Observation._FinalStage	environment(String environment)	The environment from which this observation originated.
Observation._FinalStage	environment(Optional<String> environment)
Observation.Builder	from(Observation other)
Observation.TypeStage	id(String id)	The unique identifier of the observation
Observation._FinalStage	input(Object input)	The input data of the observation
Observation._FinalStage	input(Optional<Object> input)
Observation._FinalStage	level(ObservationLevel level)	The level of the observation
Observation._FinalStage	metadata(Object metadata)	Additional metadata of the observation
Observation._FinalStage	metadata(Optional<Object> metadata)
Observation._FinalStage	model(String model)	The model used for the observation
Observation._FinalStage	model(Optional<String> model)
Observation._FinalStage	modelParameters(Map<String,MapValue> modelParameters)	The parameters of the model used for the observation
Observation._FinalStage	modelParameters(Optional<Map<String,MapValue>> modelParameters)
Observation._FinalStage	name(String name)	The name of the observation
Observation._FinalStage	name(Optional<String> name)
Observation._FinalStage	output(Object output)	The output data of the observation
Observation._FinalStage	output(Optional<Object> output)
Observation._FinalStage	parentObservationId(String parentObservationId)	The parent observation ID
Observation._FinalStage	parentObservationId(Optional<String> parentObservationId)
Observation._FinalStage	promptId(String promptId)	The prompt ID associated with the observation
Observation._FinalStage	promptId(Optional<String> promptId)
Observation.LevelStage	startTime(OffsetDateTime startTime)	The start time of the observation
Observation._FinalStage	statusMessage(String statusMessage)	The status message of the observation
Observation._FinalStage	statusMessage(Optional<String> statusMessage)
Observation._FinalStage	traceId(String traceId)	The trace ID associated with the observation
Observation._FinalStage	traceId(Optional<String> traceId)
Observation.StartTimeStage	type(String type)	The type of the observation
Observation._FinalStage	usage(Usage usage)	(Deprecated.
Observation._FinalStage	usage(Optional<Usage> usage)
Observation._FinalStage	usageDetails(Map<String,Integer> usageDetails)	The usage details of the observation.
Observation._FinalStage	usageDetails(Optional<Map<String,Integer>> usageDetails)
Observation._FinalStage	version(String version)	The version of the observation
Observation._FinalStage	version(Optional<String> version)

Methods inherited from class Object

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

Method Details

from

public Observation.Builder from(Observation other)

Specified by:

from in interface Observation.IdStage

id

public Observation.TypeStage id(@NotNull
 String id)

The unique identifier of the observation

Specified by:

id in interface Observation.IdStage

Returns:

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

type

public Observation.StartTimeStage type(@NotNull
 String type)

The type of the observation

Specified by:

type in interface Observation.TypeStage

Returns:

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

startTime

public Observation.LevelStage startTime(@NotNull
 OffsetDateTime startTime)

The start time of the observation

Specified by:

startTime in interface Observation.StartTimeStage

Returns:

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

level

public Observation._FinalStage level(@NotNull
 ObservationLevel level)

The level of the observation

Specified by:

level in interface Observation.LevelStage

Returns:

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

environment

public Observation._FinalStage environment(String environment)

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

Specified by:

environment in interface Observation._FinalStage

Returns:

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

environment

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

Specified by:

environment in interface Observation._FinalStage

costDetails

public Observation._FinalStage costDetails(Map<String,Double> costDetails)

The cost details of the observation. Key is the name of the cost metric, value is the cost in USD. The total key is the sum of all (non-total) cost metrics or the total value ingested.

Specified by:

costDetails in interface Observation._FinalStage

Returns:

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

costDetails

public Observation._FinalStage costDetails(Optional<Map<String,Double>> costDetails)

Specified by:

costDetails in interface Observation._FinalStage

usageDetails

public Observation._FinalStage usageDetails(Map<String,Integer> usageDetails)

The usage details of the observation. Key is the name of the usage metric, value is the number of units consumed. The total key is the sum of all (non-total) usage metrics or the total value ingested.

Specified by:

usageDetails in interface Observation._FinalStage

Returns:

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

usageDetails

public Observation._FinalStage usageDetails(Optional<Map<String,Integer>> usageDetails)

Specified by:

usageDetails in interface Observation._FinalStage

promptId

public Observation._FinalStage promptId(String promptId)

The prompt ID associated with the observation

Specified by:

promptId in interface Observation._FinalStage

Returns:

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

promptId

public Observation._FinalStage promptId(Optional<String> promptId)

Specified by:

promptId in interface Observation._FinalStage

parentObservationId

public Observation._FinalStage parentObservationId(String parentObservationId)

The parent observation ID

Specified by:

parentObservationId in interface Observation._FinalStage

Returns:

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

parentObservationId

public Observation._FinalStage parentObservationId(Optional<String> parentObservationId)

Specified by:

parentObservationId in interface Observation._FinalStage

statusMessage

public Observation._FinalStage statusMessage(String statusMessage)

The status message of the observation

Specified by:

statusMessage in interface Observation._FinalStage

Returns:

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

statusMessage

public Observation._FinalStage statusMessage(Optional<String> statusMessage)

Specified by:

statusMessage in interface Observation._FinalStage

usage

public Observation._FinalStage usage(Usage usage)

(Deprecated. Use usageDetails and costDetails instead.) The usage data of the observation

Specified by:

usage in interface Observation._FinalStage

Returns:

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

usage

public Observation._FinalStage usage(Optional<Usage> usage)

Specified by:

usage in interface Observation._FinalStage

output

public Observation._FinalStage output(Object output)

The output data of the observation

Specified by:

output in interface Observation._FinalStage

Returns:

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

output

public Observation._FinalStage output(Optional<Object> output)

Specified by:

output in interface Observation._FinalStage

metadata

public Observation._FinalStage metadata(Object metadata)

Additional metadata of the observation

Specified by:

metadata in interface Observation._FinalStage

Returns:

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

metadata

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

Specified by:

metadata in interface Observation._FinalStage

version

public Observation._FinalStage version(String version)

The version of the observation

Specified by:

version in interface Observation._FinalStage

Returns:

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

version

public Observation._FinalStage version(Optional<String> version)

Specified by:

version in interface Observation._FinalStage

input

public Observation._FinalStage input(Object input)

The input data of the observation

Specified by:

input in interface Observation._FinalStage

Returns:

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

input

public Observation._FinalStage input(Optional<Object> input)

Specified by:

input in interface Observation._FinalStage

modelParameters

public Observation._FinalStage modelParameters(Map<String,MapValue> modelParameters)

The parameters of the model used for the observation

Specified by:

modelParameters in interface Observation._FinalStage

Returns:

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

modelParameters

public Observation._FinalStage modelParameters(Optional<Map<String,MapValue>> modelParameters)

Specified by:

modelParameters in interface Observation._FinalStage

model

public Observation._FinalStage model(String model)

The model used for the observation

Specified by:

model in interface Observation._FinalStage

Returns:

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

model

public Observation._FinalStage model(Optional<String> model)

Specified by:

model in interface Observation._FinalStage

completionStartTime

public Observation._FinalStage completionStartTime(OffsetDateTime completionStartTime)

The completion start time of the observation

Specified by:

completionStartTime in interface Observation._FinalStage

Returns:

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

completionStartTime

public Observation._FinalStage completionStartTime(Optional<OffsetDateTime> completionStartTime)

Specified by:

completionStartTime in interface Observation._FinalStage

endTime

public Observation._FinalStage endTime(OffsetDateTime endTime)

The end time of the observation.

Specified by:

endTime in interface Observation._FinalStage

Returns:

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

endTime

public Observation._FinalStage endTime(Optional<OffsetDateTime> endTime)

Specified by:

endTime in interface Observation._FinalStage

name

public Observation._FinalStage name(String name)

The name of the observation

Specified by:

name in interface Observation._FinalStage

Returns:

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

name

public Observation._FinalStage name(Optional<String> name)

Specified by:

name in interface Observation._FinalStage

traceId

public Observation._FinalStage traceId(String traceId)

The trace ID associated with the observation

Specified by:

traceId in interface Observation._FinalStage

Returns:

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

traceId

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

Specified by:

traceId in interface Observation._FinalStage

build

public Observation build()

Specified by:

build in interface Observation._FinalStage