org.yamcs.protobuf.SubscribeTransfersRequestOrBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation

Used by external clients to communicate with Yamcs

There is a newer version: 5.10.9

// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yamcs/protobuf/filetransfer/filetransfer.proto

package org.yamcs.protobuf;

public interface SubscribeTransfersRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.filetransfer.SubscribeTransfersRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 1;
   * @return Whether the instance field is set.
   */
  boolean hasInstance();
  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 1;
   * @return The instance.
   */
  java.lang.String getInstance();
  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 1;
   * @return The bytes for instance.
   */
  com.google.protobuf.ByteString
      getInstanceBytes();

  /**
   *    * File transfer service name
   * 
   *
   * optional string serviceName = 2;
   * @return Whether the serviceName field is set.
   */
  boolean hasServiceName();
  /**
   *    * File transfer service name
   * 
   *
   * optional string serviceName = 2;
   * @return The serviceName.
   */
  java.lang.String getServiceName();
  /**
   *    * File transfer service name
   * 
   *
   * optional string serviceName = 2;
   * @return The bytes for serviceName.
   */
  com.google.protobuf.ByteString
      getServiceNameBytes();

  /**
   *    * 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;
   * @return Whether the ongoingOnly field is set.
   */
  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;
   * @return The ongoingOnly.
   */
  boolean getOngoingOnly();
}