Subscribe Containers¶

interface SubscribeContainersRequest {

  // Yamcs instance name
  instance: string;

  // Processor name
  processor: string;

  // Container names to subscribe to.
  names: string[];

  // Filter query. See {doc}`../filtering` for how to write a filter query.
  //
  // Literal text search matches against the `name` field.
  // Field comparisons can use any of the following fields:
  //
  // | Field       | Type   | Description                                 |
  // | ----------- | ------ | -------------------------------------------- |
  // | `name`      | string | Filter by qualified container name           |
  // | `link`      | string | Filter by receiving link                     |
  // | `size`      | number | Filter by received container size in bytes   |
  // | `seqNumber` | number | Filter by sequence count                     |
  //
  // If `names` is empty and this filter only uses text search or `name` comparisons, only
  // matching containers are subscribed to. If it also uses `link`, `size` or `seqNumber`
  // (only known once a container has actually been received), every container in the
  // Mission Database is subscribed to instead.
  filter: string;
}

interface ContainerData {

  // Container name
  name: string;

  // When the container's packet was generated (packet time)
  generationTime: string;  // RFC 3339 timestamp

  // Whent the container's packet was received by Yamcs
  receptionTime: string;  // RFC 3339 timestamp

  // Container bytes
  binary: string;  // Base64

  // Sequence count - it is generated by the link when the container is injected into Yamcs.
  // In case this is part of a sub-container, the sequence count is the one from the encompassing container
  seqCount: number;
}