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

Class ListTransfersRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
org.yamcs.protobuf.ListTransfersRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ListTransfersRequestOrBuilder
@Generated public final class ListTransfersRequest extends com.google.protobuf.GeneratedMessage implements ListTransfersRequestOrBuilder
Protobuf type yamcs.protobuf.filetransfer.ListTransfersRequest
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasInstance

      public boolean hasInstance()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      hasInstance in interface ListTransfersRequestOrBuilder
      Returns:
      Whether the instance field is set.

    • getInstance

      public String getInstance()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      getInstance in interface ListTransfersRequestOrBuilder
      Returns:
      The instance.

    • getInstanceBytes

      public com.google.protobuf.ByteString getInstanceBytes()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      getInstanceBytes in interface ListTransfersRequestOrBuilder
      Returns:
      The bytes for instance.

    • hasServiceName

      public boolean hasServiceName()
       File transfer service name
      optional string serviceName = 2;
      Specified by:
      hasServiceName in interface ListTransfersRequestOrBuilder
      Returns:
      Whether the serviceName field is set.

    • getServiceName

      public String getServiceName()
       File transfer service name
      optional string serviceName = 2;
      Specified by:
      getServiceName in interface ListTransfersRequestOrBuilder
      Returns:
      The serviceName.

    • getServiceNameBytes

      public com.google.protobuf.ByteString getServiceNameBytes()
       File transfer service name
      optional string serviceName = 2;
      Specified by:
      getServiceNameBytes in interface ListTransfersRequestOrBuilder
      Returns:
      The bytes for serviceName.

    • hasStart

      public 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;
      Specified by:
      hasStart in interface ListTransfersRequestOrBuilder
      Returns:
      Whether the start field is set.

    • getStart

      public 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;
      Specified by:
      getStart in interface ListTransfersRequestOrBuilder
      Returns:
      The start.

    • getStartOrBuilder

      public 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;
      Specified by:
      getStartOrBuilder in interface ListTransfersRequestOrBuilder

    • hasStop

      public 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;
      Specified by:
      hasStop in interface ListTransfersRequestOrBuilder
      Returns:
      Whether the stop field is set.

    • getStop

      public 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;
      Specified by:
      getStop in interface ListTransfersRequestOrBuilder
      Returns:
      The stop.

    • getStopOrBuilder

      public 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;
      Specified by:
      getStopOrBuilder in interface ListTransfersRequestOrBuilder

    • hasLocalEntityId

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

    • getLocalEntityId

      public long getLocalEntityId()
       Filter by local entity identifier
      optional int64 localEntityId = 5;
      Specified by:
      getLocalEntityId in interface ListTransfersRequestOrBuilder
      Returns:
      The localEntityId.

    • hasRemoteEntityId

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

    • getRemoteEntityId

      public long getRemoteEntityId()
       Filter by remote entity identifier
      optional int64 remoteEntityId = 6;
      Specified by:
      getRemoteEntityId in interface ListTransfersRequestOrBuilder
      Returns:
      The remoteEntityId.

    • getStateList

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

    • getStateCount

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

    • getState

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

    • hasDirection

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

    • getDirection

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

    • hasLimit

      public 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;
      Specified by:
      hasLimit in interface ListTransfersRequestOrBuilder
      Returns:
      Whether the limit field is set.

    • getLimit

      public 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;
      Specified by:
      getLimit in interface ListTransfersRequestOrBuilder
      Returns:
      The limit.

    • hasOrder

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

    • getOrder

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

    • getOrderBytes

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ListTransfersRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListTransfersRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListTransfersRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListTransfersRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListTransfersRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListTransfersRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListTransfersRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListTransfersRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListTransfersRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListTransfersRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListTransfersRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListTransfersRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ListTransfersRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ListTransfersRequest.Builder newBuilder()

    • newBuilder

      public static ListTransfersRequest.Builder newBuilder(ListTransfersRequest prototype)

    • toBuilder

      public ListTransfersRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ListTransfersRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ListTransfersRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListTransfersRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ListTransfersRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ListTransfersRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder