org.yamcs.protobuf.ListTransfersRequestOrBuilder 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 ListTransfersRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.filetransfer.ListTransfersRequest)
    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();

  /**
   *    * Filter the lower bound of the transfer's creation time.
   * Specify a date string in ISO 8601 format. This bound is
   * inclusive.
   * 
   *
   * optional .google.protobuf.Timestamp start = 3;
   * @return Whether the start field is set.
   */
  boolean hasStart();
  /**
   *    * Filter the lower bound of the transfer's creation time.
   * Specify a date string in ISO 8601 format. This bound is
   * inclusive.
   * 
   *
   * optional .google.protobuf.Timestamp start = 3;
   * @return The start.
   */
  com.google.protobuf.Timestamp getStart();
  /**
   *    * Filter the lower bound of the transfer's creation time.
   * Specify a date string in ISO 8601 format. This bound is
   * inclusive.
   * 
   *
   * optional .google.protobuf.Timestamp start = 3;
   */
  com.google.protobuf.TimestampOrBuilder getStartOrBuilder();

  /**
   *    * Filter the upper bound of the transfer's creation time.
   * Specify a date string in ISO 8601 format. This bound is
   * exclusive.
   * 
   *
   * optional .google.protobuf.Timestamp stop = 4;
   * @return Whether the stop field is set.
   */
  boolean hasStop();
  /**
   *    * Filter the upper bound of the transfer's creation time.
   * Specify a date string in ISO 8601 format. This bound is
   * exclusive.
   * 
   *
   * optional .google.protobuf.Timestamp stop = 4;
   * @return The stop.
   */
  com.google.protobuf.Timestamp getStop();
  /**
   *    * Filter the upper bound of the transfer's creation time.
   * Specify a date string in ISO 8601 format. This bound is
   * exclusive.
   * 
   *
   * optional .google.protobuf.Timestamp stop = 4;
   */
  com.google.protobuf.TimestampOrBuilder getStopOrBuilder();

  /**
   *    * Filter by local entity identifier
   * 
   *
   * optional int64 localEntityId = 5;
   * @return Whether the localEntityId field is set.
   */
  boolean hasLocalEntityId();
  /**
   *    * Filter by local entity identifier
   * 
   *
   * optional int64 localEntityId = 5;
   * @return The localEntityId.
   */
  long getLocalEntityId();

  /**
   *    * Filter by remote entity identifier
   * 
   *
   * optional int64 remoteEntityId = 6;
   * @return Whether the remoteEntityId field is set.
   */
  boolean hasRemoteEntityId();
  /**
   *    * Filter by remote entity identifier
   * 
   *
   * optional int64 remoteEntityId = 6;
   * @return The remoteEntityId.
   */
  long getRemoteEntityId();

  /**
   *    * Filter by transfer state. Leave empty to return any.
   * 
   *
   * repeated .yamcs.protobuf.filetransfer.TransferState state = 7;
   * @return A list containing the state.
   */
  java.util.List getStateList();
  /**
   *    * Filter by transfer state. Leave empty to return any.
   * 
   *
   * repeated .yamcs.protobuf.filetransfer.TransferState state = 7;
   * @return The count of state.
   */
  int getStateCount();
  /**
   *    * Filter by transfer state. Leave empty to return any.
   * 
   *
   * repeated .yamcs.protobuf.filetransfer.TransferState state = 7;
   * @param index The index of the element to return.
   * @return The state at the given index.
   */
  org.yamcs.protobuf.TransferState getState(int index);

  /**
   *    * Filter by transfer direction (UPLOAD or DOWNLOAD)
   * 
   *
   * optional .yamcs.protobuf.filetransfer.TransferDirection direction = 8;
   * @return Whether the direction field is set.
   */
  boolean hasDirection();
  /**
   *    * Filter by transfer direction (UPLOAD or DOWNLOAD)
   * 
   *
   * optional .yamcs.protobuf.filetransfer.TransferDirection direction = 8;
   * @return The direction.
   */
  org.yamcs.protobuf.TransferDirection getDirection();

  /**
   *    * The maximum number of returned records per page. Choose this value too high
   * and you risk hitting the maximum response size limit enforced by the server.
   * Default: ``100``
   * 
   *
   * optional int32 limit = 9;
   * @return Whether the limit field is set.
   */
  boolean hasLimit();
  /**
   *    * The maximum number of returned records per page. Choose this value too high
   * and you risk hitting the maximum response size limit enforced by the server.
   * Default: ``100``
   * 
   *
   * optional int32 limit = 9;
   * @return The limit.
   */
  int getLimit();

  /**
   *    * The order of the returned results. Can be either ``asc`` or ``desc``.
   * Default: ``desc``
   * 
   *
   * optional string order = 10;
   * @return Whether the order field is set.
   */
  boolean hasOrder();
  /**
   *    * The order of the returned results. Can be either ``asc`` or ``desc``.
   * Default: ``desc``
   * 
   *
   * optional string order = 10;
   * @return The order.
   */
  java.lang.String getOrder();
  /**
   *    * The order of the returned results. Can be either ``asc`` or ``desc``.
   * Default: ``desc``
   * 
   *
   * optional string order = 10;
   * @return The bytes for order.
   */
  com.google.protobuf.ByteString
      getOrderBytes();
}