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

Interface ListTransfersRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    TransferDirection
    getDirection()
    Filter by transfer direction (UPLOAD or DOWNLOAD)
    String
    getInstance()
    Yamcs instance name
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name
    int
    getLimit()
    The maximum number of returned records per page.
    long
    getLocalEntityId()
    Filter by local entity identifier
    String
    getOrder()
    The order of the returned results.
    com.google.protobuf.ByteString
    getOrderBytes()
    The order of the returned results.
    long
    getRemoteEntityId()
    Filter by remote entity identifier
    String
    getServiceName()
    File transfer service name
    com.google.protobuf.ByteString
    getServiceNameBytes()
    File transfer service name
    com.google.protobuf.Timestamp
    getStart()
    Filter the lower bound of the transfer's creation time.
    com.google.protobuf.TimestampOrBuilder
    getStartOrBuilder()
    Filter the lower bound of the transfer's creation time.
    TransferState
    getState(int index)
    Filter by transfer state.
    int
    getStateCount()
    Filter by transfer state.
    List<TransferState>
    getStateList()
    Filter by transfer state.
    com.google.protobuf.Timestamp
    getStop()
    Filter the upper bound of the transfer's creation time.
    com.google.protobuf.TimestampOrBuilder
    getStopOrBuilder()
    Filter the upper bound of the transfer's creation time.
    boolean
    hasDirection()
    Filter by transfer direction (UPLOAD or DOWNLOAD)
    boolean
    hasInstance()
    Yamcs instance name
    boolean
    hasLimit()
    The maximum number of returned records per page.
    boolean
    hasLocalEntityId()
    Filter by local entity identifier
    boolean
    hasOrder()
    The order of the returned results.
    boolean
    hasRemoteEntityId()
    Filter by remote entity identifier
    boolean
    hasServiceName()
    File transfer service name
    boolean
    hasStart()
    Filter the lower bound of the transfer's creation time.
    boolean
    hasStop()
    Filter the upper bound of the transfer's creation time.

    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.

    • hasStart

      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;
      Returns:
      Whether the start field is set.

    • getStart

      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;
      Returns:
      The start.

    • getStartOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
       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;

    • hasStop

      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;
      Returns:
      Whether the stop field is set.

    • getStop

      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;
      Returns:
      The stop.

    • getStopOrBuilder

      com.google.protobuf.TimestampOrBuilder getStopOrBuilder()
       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;

    • hasLocalEntityId

      boolean hasLocalEntityId()
       Filter by local entity identifier
      optional int64 localEntityId = 5;
      Returns:
      Whether the localEntityId field is set.

    • getLocalEntityId

      long getLocalEntityId()
       Filter by local entity identifier
      optional int64 localEntityId = 5;
      Returns:
      The localEntityId.

    • hasRemoteEntityId

      boolean hasRemoteEntityId()
       Filter by remote entity identifier
      optional int64 remoteEntityId = 6;
      Returns:
      Whether the remoteEntityId field is set.

    • getRemoteEntityId

      long getRemoteEntityId()
       Filter by remote entity identifier
      optional int64 remoteEntityId = 6;
      Returns:
      The remoteEntityId.

    • getStateList

      List<TransferState> getStateList()
       Filter by transfer state. Leave empty to return any.
      repeated .yamcs.protobuf.filetransfer.TransferState state = 7;
      Returns:
      A list containing the state.

    • getStateCount

      int getStateCount()
       Filter by transfer state. Leave empty to return any.
      repeated .yamcs.protobuf.filetransfer.TransferState state = 7;
      Returns:
      The count of state.

    • getState

      TransferState getState(int index)
       Filter by transfer state. Leave empty to return any.
      repeated .yamcs.protobuf.filetransfer.TransferState state = 7;
      Parameters:
      index - The index of the element to return.
      Returns:
      The state at the given index.

    • hasDirection

      boolean hasDirection()
       Filter by transfer direction (UPLOAD or DOWNLOAD)
      optional .yamcs.protobuf.filetransfer.TransferDirection direction = 8;
      Returns:
      Whether the direction field is set.

    • getDirection

      TransferDirection getDirection()
       Filter by transfer direction (UPLOAD or DOWNLOAD)
      optional .yamcs.protobuf.filetransfer.TransferDirection direction = 8;
      Returns:
      The direction.

    • hasLimit

      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;
      Returns:
      Whether the limit field is set.

    • getLimit

      int getLimit()
       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;
      Returns:
      The limit.

    • hasOrder

      boolean hasOrder()
       The order of the returned results. Can be either `asc` or `desc`.
 Default: `desc`
      optional string order = 10;
      Returns:
      Whether the order field is set.

    • getOrder

      String getOrder()
       The order of the returned results. Can be either `asc` or `desc`.
 Default: `desc`
      optional string order = 10;
      Returns:
      The order.

    • getOrderBytes

      com.google.protobuf.ByteString getOrderBytes()
       The order of the returned results. Can be either `asc` or `desc`.
 Default: `desc`
      optional string order = 10;
      Returns:
      The bytes for order.