Module org.yamcs.api
Package org.yamcs.protobuf

Interface SubscribeTransfersRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SubscribeTransfersRequest, SubscribeTransfersRequest.Builder
@Generated public interface SubscribeTransfersRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getInstance()
    Yamcs instance name
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name
    boolean
    getOngoingOnly()
    If true, send info on all currently ongoing transfers, as well as any future updates (recommended).
    String
    getServiceName()
    File transfer service name
    com.google.protobuf.ByteString
    getServiceNameBytes()
    File transfer service name
    boolean
    hasInstance()
    Yamcs instance name
    boolean
    hasOngoingOnly()
    If true, send info on all currently ongoing transfers, as well as any future updates (recommended).
    boolean
    hasServiceName()
    File transfer service name

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasInstance

      boolean hasInstance()
       Yamcs instance name
      optional string instance = 1;
      Returns:
      Whether the instance field is set.

    • getInstance

      String getInstance()
       Yamcs instance name
      optional string instance = 1;
      Returns:
      The instance.

    • getInstanceBytes

      com.google.protobuf.ByteString getInstanceBytes()
       Yamcs instance name
      optional string instance = 1;
      Returns:
      The bytes for instance.

    • hasServiceName

      boolean hasServiceName()
       File transfer service name
      optional string serviceName = 2;
      Returns:
      Whether the serviceName field is set.

    • getServiceName

      String getServiceName()
       File transfer service name
      optional string serviceName = 2;
      Returns:
      The serviceName.

    • getServiceNameBytes

      com.google.protobuf.ByteString getServiceNameBytes()
       File transfer service name
      optional string serviceName = 2;
      Returns:
      The bytes for serviceName.

    • hasOngoingOnly

      boolean hasOngoingOnly()
       If true, send info on all currently ongoing transfers,
 as well as any future updates (recommended).

 For legacy reasons, the default is `false`, which will
 send also finished transfers upon subscription. This behaviour
 is due for removal in a future release (if you want to receive
 past transfers, do a GET request).
      optional bool ongoingOnly = 3;
      Returns:
      Whether the ongoingOnly field is set.

    • getOngoingOnly

      boolean getOngoingOnly()
       If true, send info on all currently ongoing transfers,
 as well as any future updates (recommended).

 For legacy reasons, the default is `false`, which will
 send also finished transfers upon subscription. This behaviour
 is due for removal in a future release (if you want to receive
 past transfers, do a GET request).
      optional bool ongoingOnly = 3;
      Returns:
      The ongoingOnly.