Package velox.api.layer1.dynamichistory.metadata

Class MetadataType<T>

java.lang.Object

velox.api.layer1.dynamichistory.metadata.MetadataType<T>

Type Parameters:

T - type of the value returned by getMetadata when this token is used

Direct Known Subclasses:

MetadataType.FirstEventTimeType

public abstract sealed class MetadataType<T>
extends Object
permits MetadataType.FirstEventTimeType

Selects which piece of metadata to request from getMetadata.

Pass one of the tokens returned by the static methods of this class to getMetadata; the type of value you get back is determined by the token you pass. For example:

 Optional<FirstEventTime> first = accessInterface.getMetadata(dataSource, instrumentInfo, MetadataType.firstEventTimeType());
 

Available metadata:

• firstEventTimeType() — returns FirstEventTime, the timestamp of the earliest event available for the instrument. Or nothing if metadata is not available

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MetadataType.FirstEventTimeType	Metadata token for FirstEventTime; obtain it from firstEventTimeType().

Field Summary

Fields

Modifier and Type	Field	Description
final Class<T>	type	Type of the value returned by getMetadata for this token.

Method Summary

Modifier and Type	Method	Description
static MetadataType.FirstEventTimeType	firstEventTimeType()	Requests the time of the earliest available event for the instrument.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

type

public final Class<T> type

Type of the value returned by getMetadata for this token.

Method Details

toString

public String toString()

Overrides:

toString in class Object

firstEventTimeType

public static MetadataType.FirstEventTimeType firstEventTimeType()

Requests the time of the earliest available event for the instrument. Can return response or nothing if there is no metadata for the given instrument, in case there is no history for it, or the server was unavailable at the moment when the request was made. When passed to getMetadata, the returned stage:

• yields FirstEventTime.Found with the earliest event time, or FirstEventTime.HistoryNotAvailable if the instrument has no history;
• completes exceptionally (cause is RequestTimeoutException) if the request times out;
• completes exceptionally (cause is ServerNotAvailableException) if the server is unavailable.

Returns:

a token that makes getMetadata return a FirstEventTime