Module org.yamcs.client

Package org.yamcs.client.archive

Class ArchiveClient

java.lang.Object

org.yamcs.client.archive.ArchiveClient

public class ArchiveClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ArchiveClient.ListOptions
static final class	ArchiveClient.RangeOptions
static final class	ArchiveClient.StreamOptions
static class	ArchiveClient.TableLoader

Constructor Summary

Constructors

Constructor	Description
ArchiveClient(org.yamcs.api.MethodHandler handler, String instance)

Method Summary

Modifier and Type	Method	Description
ArchiveClient.TableLoader	createTableLoader(String table)
CompletableFuture<Void>	dumpTable(String table, StreamReceiver<org.yamcs.protobuf.Table.Row> consumer)
CompletableFuture<Command>	getCommand(String id)
CompletableFuture<List<String>>	getEventSources()
String	getInstance()
CompletableFuture<List<org.yamcs.protobuf.Pvalue.Ranges.Range>>	getRanges(String parameter, Instant start, Instant stop, ArchiveClient.RangeOptions.RangeOption... options)
CompletableFuture<List<org.yamcs.protobuf.Pvalue.TimeSeries.Sample>>	getSamples(String parameter, Instant start, Instant stop)
CompletableFuture<List<org.yamcs.protobuf.AlarmData>>	listAlarms()
CompletableFuture<List<org.yamcs.protobuf.AlarmData>>	listAlarms(String parameter)
CompletableFuture<List<org.yamcs.protobuf.AlarmData>>	listAlarms(String alarmName, Instant start, Instant stop)
CompletableFuture<List<org.yamcs.protobuf.AlarmData>>	listAlarms(Instant start, Instant stop)
CompletableFuture<Page<org.yamcs.protobuf.IndexGroup>>	listCommandIndex(Instant start, Instant stop, ArchiveClient.ListOptions.ListOption... options)
CompletableFuture<Page<Command>>	listCommands()
CompletableFuture<Page<Command>>	listCommands(Instant start, Instant stop)
CompletableFuture<Page<org.yamcs.protobuf.IndexGroup>>	listCompletenessIndex(Instant start, Instant stop, ArchiveClient.ListOptions.ListOption... options)
CompletableFuture<Page<org.yamcs.protobuf.IndexGroup>>	listEventIndex(Instant start, Instant stop, ArchiveClient.ListOptions.ListOption... options)
CompletableFuture<Page<org.yamcs.protobuf.Event>>	listEvents()
CompletableFuture<Page<org.yamcs.protobuf.Event>>	listEvents(Instant start, Instant stop)
CompletableFuture<Page<org.yamcs.protobuf.IndexGroup>>	listPacketIndex(Instant start, Instant stop, ArchiveClient.ListOptions.ListOption... options)
CompletableFuture<Page<org.yamcs.protobuf.IndexGroup>>	listParameterIndex(Instant start, Instant stop, ArchiveClient.ListOptions.ListOption... options)
CompletableFuture<List<org.yamcs.protobuf.Table.TableData.TableRecord>>	listRecords(String table)
CompletableFuture<Page<org.yamcs.protobuf.Pvalue.ParameterValue>>	listValues(String parameter, Instant start, Instant stop, ArchiveClient.ListOptions.ListOption... options)
CompletableFuture<Page<org.yamcs.protobuf.Pvalue.ParameterValue>>	listValues(String parameter, ArchiveClient.ListOptions.ListOption... options)
CompletableFuture<Void>	streamCommandIndex(StreamReceiver<org.yamcs.protobuf.Yamcs.ArchiveRecord> consumer, Instant start, Instant stop)
CompletableFuture<Void>	streamCommands(StreamReceiver<Command> consumer, Instant start, Instant stop, ArchiveClient.StreamOptions.StreamOption... options)
CompletableFuture<Void>	streamCompletenessIndex(StreamReceiver<org.yamcs.protobuf.Yamcs.ArchiveRecord> consumer, Instant start, Instant stop)
CompletableFuture<Void>	streamEventIndex(StreamReceiver<org.yamcs.protobuf.Yamcs.ArchiveRecord> consumer, Instant start, Instant stop)
CompletableFuture<Void>	streamEvents(StreamReceiver<org.yamcs.protobuf.Event> consumer, Instant start, Instant stop, ArchiveClient.StreamOptions.StreamOption... options)
CompletableFuture<Void>	streamPacketIndex(StreamReceiver<org.yamcs.protobuf.Yamcs.ArchiveRecord> consumer, Instant start, Instant stop, ArchiveClient.StreamOptions.StreamOption... options)
CompletableFuture<Void>	streamPackets(StreamReceiver<org.yamcs.protobuf.TmPacketData> consumer, Instant start, Instant stop, ArchiveClient.StreamOptions.StreamOption... options)
CompletableFuture<Void>	streamParameterIndex(StreamReceiver<org.yamcs.protobuf.Yamcs.ArchiveRecord> consumer, Instant start, Instant stop)
CompletableFuture<Void>	streamValues(List<String> parameters, List<String> tmLinks, StreamReceiver<Map<String,org.yamcs.protobuf.Pvalue.ParameterValue>> consumer, Instant start, Instant stop)
CompletableFuture<Void>	streamValues(List<String> parameters, StreamReceiver<Map<String,org.yamcs.protobuf.Pvalue.ParameterValue>> consumer, Instant start, Instant stop)

Methods inherited from class java.lang.Object

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

Constructor Details

ArchiveClient

public ArchiveClient(org.yamcs.api.MethodHandler handler,
 String instance)

Method Details

getInstance

public String getInstance()

listCommandIndex

public CompletableFuture<Page<org.yamcs.protobuf.IndexGroup>> listCommandIndex(Instant start,
 Instant stop,
 ArchiveClient.ListOptions.ListOption... options)

listPacketIndex

public CompletableFuture<Page<org.yamcs.protobuf.IndexGroup>> listPacketIndex(Instant start,
 Instant stop,
 ArchiveClient.ListOptions.ListOption... options)

listParameterIndex

public CompletableFuture<Page<org.yamcs.protobuf.IndexGroup>> listParameterIndex(Instant start,
 Instant stop,
 ArchiveClient.ListOptions.ListOption... options)

listEventIndex

public CompletableFuture<Page<org.yamcs.protobuf.IndexGroup>> listEventIndex(Instant start,
 Instant stop,
 ArchiveClient.ListOptions.ListOption... options)

listCompletenessIndex

public CompletableFuture<Page<org.yamcs.protobuf.IndexGroup>> listCompletenessIndex(Instant start,
 Instant stop,
 ArchiveClient.ListOptions.ListOption... options)

streamPacketIndex

public CompletableFuture<Void> streamPacketIndex(StreamReceiver<org.yamcs.protobuf.Yamcs.ArchiveRecord> consumer,
 Instant start,
 Instant stop,
 ArchiveClient.StreamOptions.StreamOption... options)

streamParameterIndex

public CompletableFuture<Void> streamParameterIndex(StreamReceiver<org.yamcs.protobuf.Yamcs.ArchiveRecord> consumer,
 Instant start,
 Instant stop)

streamCommandIndex

public CompletableFuture<Void> streamCommandIndex(StreamReceiver<org.yamcs.protobuf.Yamcs.ArchiveRecord> consumer,
 Instant start,
 Instant stop)

streamEventIndex

public CompletableFuture<Void> streamEventIndex(StreamReceiver<org.yamcs.protobuf.Yamcs.ArchiveRecord> consumer,
 Instant start,
 Instant stop)

streamCompletenessIndex

public CompletableFuture<Void> streamCompletenessIndex(StreamReceiver<org.yamcs.protobuf.Yamcs.ArchiveRecord> consumer,
 Instant start,
 Instant stop)

listCommands

public CompletableFuture<Page<Command>> listCommands()

listCommands

public CompletableFuture<Page<Command>> listCommands(Instant start,
 Instant stop)

getCommand

public CompletableFuture<Command> getCommand(String id)

streamCommands

public CompletableFuture<Void> streamCommands(StreamReceiver<Command> consumer,
 Instant start,
 Instant stop,
 ArchiveClient.StreamOptions.StreamOption... options)

listEvents

public CompletableFuture<Page<org.yamcs.protobuf.Event>> listEvents()

listEvents

public CompletableFuture<Page<org.yamcs.protobuf.Event>> listEvents(Instant start,
 Instant stop)

streamEvents

public CompletableFuture<Void> streamEvents(StreamReceiver<org.yamcs.protobuf.Event> consumer,
 Instant start,
 Instant stop,
 ArchiveClient.StreamOptions.StreamOption... options)

streamPackets

public CompletableFuture<Void> streamPackets(StreamReceiver<org.yamcs.protobuf.TmPacketData> consumer,
 Instant start,
 Instant stop,
 ArchiveClient.StreamOptions.StreamOption... options)

streamValues

public CompletableFuture<Void> streamValues(List<String> parameters,
 StreamReceiver<Map<String,org.yamcs.protobuf.Pvalue.ParameterValue>> consumer,
 Instant start,
 Instant stop)

streamValues

public CompletableFuture<Void> streamValues(List<String> parameters,
 List<String> tmLinks,
 StreamReceiver<Map<String,org.yamcs.protobuf.Pvalue.ParameterValue>> consumer,
 Instant start,
 Instant stop)

listAlarms

public CompletableFuture<List<org.yamcs.protobuf.AlarmData>> listAlarms()

listAlarms

public CompletableFuture<List<org.yamcs.protobuf.AlarmData>> listAlarms(String parameter)

listAlarms

public CompletableFuture<List<org.yamcs.protobuf.AlarmData>> listAlarms(Instant start,
 Instant stop)

listAlarms

public CompletableFuture<List<org.yamcs.protobuf.AlarmData>> listAlarms(String alarmName,
 Instant start,
 Instant stop)

listRecords

public CompletableFuture<List<org.yamcs.protobuf.Table.TableData.TableRecord>> listRecords(String table)

listValues

public CompletableFuture<Page<org.yamcs.protobuf.Pvalue.ParameterValue>> listValues(String parameter,
 ArchiveClient.ListOptions.ListOption... options)

listValues

public CompletableFuture<Page<org.yamcs.protobuf.Pvalue.ParameterValue>> listValues(String parameter,
 Instant start,
 Instant stop,
 ArchiveClient.ListOptions.ListOption... options)

getSamples

public CompletableFuture<List<org.yamcs.protobuf.Pvalue.TimeSeries.Sample>> getSamples(String parameter,
 Instant start,
 Instant stop)

getRanges

public CompletableFuture<List<org.yamcs.protobuf.Pvalue.Ranges.Range>> getRanges(String parameter,
 Instant start,
 Instant stop,
 ArchiveClient.RangeOptions.RangeOption... options)

getEventSources

public CompletableFuture<List<String>> getEventSources()

dumpTable

public CompletableFuture<Void> dumpTable(String table,
 StreamReceiver<org.yamcs.protobuf.Table.Row> consumer)

createTableLoader

public ArchiveClient.TableLoader createTableLoader(String table)