Package org.finos.tracdap.api

Class DataReadRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
org.finos.tracdap.api.DataReadRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, DataReadRequestOrBuilder
public final class DataReadRequest extends com.google.protobuf.GeneratedMessage implements DataReadRequestOrBuilder
 *
 Request to read a dataset stored in the TRAC platform.

 @see TracDataApi.readDataset
Protobuf type tracdap.api.DataReadRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DataReadRequest.Builder
    * Request to read a dataset stored in the TRAC platform.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FORMAT_FIELD_NUMBER
     
    static final int
    LIMIT_FIELD_NUMBER
     
    static final int
    OFFSET_FIELD_NUMBER
     
    static final int
    SELECTOR_FIELD_NUMBER
     
    static final int
    TENANT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static DataReadRequest
    getDefaultInstance()
     
    DataReadRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFormat()
    * Format that the dataset will be returned in.
    com.google.protobuf.ByteString
    getFormatBytes()
    * Format that the dataset will be returned in.
    long
    getLimit()
    * Limit the number of rows returned by the request (optional).
    long
    getOffset()
    * Read dataset starting at the row with the given offset (optional).
    com.google.protobuf.Parser<DataReadRequest>
    getParserForType()
     
    org.finos.tracdap.metadata.TagSelector
    getSelector()
    * Selector for the dataset being read
    org.finos.tracdap.metadata.TagSelectorOrBuilder
    getSelectorOrBuilder()
    * Selector for the dataset being read
    int
    getSerializedSize()
     
    String
    getTenant()
    * Tenant code for the requested operation, always required.
    com.google.protobuf.ByteString
    getTenantBytes()
    * Tenant code for the requested operation, always required.
    int
    hashCode()
     
    boolean
    hasLimit()
    * Limit the number of rows returned by the request (optional).
    boolean
    hasOffset()
    * Read dataset starting at the row with the given offset (optional).
    boolean
    hasSelector()
    * Selector for the dataset being read
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DataReadRequest.Builder
    newBuilder()
     
    static DataReadRequest.Builder
    newBuilder(DataReadRequest prototype)
     
    DataReadRequest.Builder
    newBuilderForType()
     
    protected DataReadRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static DataReadRequest
    parseDelimitedFrom(InputStream input)
     
    static DataReadRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DataReadRequest
    parseFrom(byte[] data)
     
    static DataReadRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DataReadRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static DataReadRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DataReadRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DataReadRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DataReadRequest
    parseFrom(InputStream input)
     
    static DataReadRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DataReadRequest
    parseFrom(ByteBuffer data)
     
    static DataReadRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DataReadRequest>
    parser()
     
    DataReadRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getTenant

      public String getTenant()
       *
 Tenant code for the requested operation, always required.
      string tenant = 1;
      Specified by:
      getTenant in interface DataReadRequestOrBuilder
      Returns:
      The tenant.

    • getTenantBytes

      public com.google.protobuf.ByteString getTenantBytes()
       *
 Tenant code for the requested operation, always required.
      string tenant = 1;
      Specified by:
      getTenantBytes in interface DataReadRequestOrBuilder
      Returns:
      The bytes for tenant.

    • hasSelector

      public boolean hasSelector()
       *
 Selector for the dataset being read
      .tracdap.metadata.TagSelector selector = 2;
      Specified by:
      hasSelector in interface DataReadRequestOrBuilder
      Returns:
      Whether the selector field is set.

    • getSelector

      public org.finos.tracdap.metadata.TagSelector getSelector()
       *
 Selector for the dataset being read
      .tracdap.metadata.TagSelector selector = 2;
      Specified by:
      getSelector in interface DataReadRequestOrBuilder
      Returns:
      The selector.

    • getSelectorOrBuilder

      public org.finos.tracdap.metadata.TagSelectorOrBuilder getSelectorOrBuilder()
       *
 Selector for the dataset being read
      .tracdap.metadata.TagSelector selector = 2;
      Specified by:
      getSelectorOrBuilder in interface DataReadRequestOrBuilder

    • getFormat

      public String getFormat()
       *
 Format that the dataset will be returned in.

 The format must be the mime type of a supported data format.
 Data will be encoded in this format before it is sent back.
      string format = 3;
      Specified by:
      getFormat in interface DataReadRequestOrBuilder
      Returns:
      The format.

    • getFormatBytes

      public com.google.protobuf.ByteString getFormatBytes()
       *
 Format that the dataset will be returned in.

 The format must be the mime type of a supported data format.
 Data will be encoded in this format before it is sent back.
      string format = 3;
      Specified by:
      getFormatBytes in interface DataReadRequestOrBuilder
      Returns:
      The bytes for format.

    • hasLimit

      public boolean hasLimit()
       *
 Limit the number of rows returned by the request (optional).

 If specified the server will limit the number of rows returned.
 There is a hard limit configured in the back end, TRAC will never return
 more rows than the hard limit regardless of the limit value supplied by
 the client. If no limit value is supplied, the back end hard limit will
 still be applied.

 The returned rows are not ordered however ordering is guaranteed
 to stay the same for any particular dataset, i.e. two requests for the
 same dataset will return rows in the same order. If the dataset is
 expunged and recreated on the platform, e.g. by a re-run after an
 expired retention period, the ordering of the dataset may change.
      optional uint64 limit = 4;
      Specified by:
      hasLimit in interface DataReadRequestOrBuilder
      Returns:
      Whether the limit field is set.

    • getLimit

      public long getLimit()
       *
 Limit the number of rows returned by the request (optional).

 If specified the server will limit the number of rows returned.
 There is a hard limit configured in the back end, TRAC will never return
 more rows than the hard limit regardless of the limit value supplied by
 the client. If no limit value is supplied, the back end hard limit will
 still be applied.

 The returned rows are not ordered however ordering is guaranteed
 to stay the same for any particular dataset, i.e. two requests for the
 same dataset will return rows in the same order. If the dataset is
 expunged and recreated on the platform, e.g. by a re-run after an
 expired retention period, the ordering of the dataset may change.
      optional uint64 limit = 4;
      Specified by:
      getLimit in interface DataReadRequestOrBuilder
      Returns:
      The limit.

    • hasOffset

      public boolean hasOffset()
       *
 Read dataset starting at the row with the given offset (optional).

 If specified the server will start the read operation at the given row offset.
 Can be combined with the limit parameter to achieve pagination.
 If the offset is greater than the size of the dataset, no rows will be returned.

 The returned rows are not ordered however ordering is guaranteed
 to stay the same for any particular dataset, i.e. two requests for the
 same dataset will return rows in the same order. If the dataset is
 expunged and recreated on the platform, e.g. by a re-run after an
 expired retention period, the ordering of the dataset may change.
      optional uint64 offset = 5;
      Specified by:
      hasOffset in interface DataReadRequestOrBuilder
      Returns:
      Whether the offset field is set.

    • getOffset

      public long getOffset()
       *
 Read dataset starting at the row with the given offset (optional).

 If specified the server will start the read operation at the given row offset.
 Can be combined with the limit parameter to achieve pagination.
 If the offset is greater than the size of the dataset, no rows will be returned.

 The returned rows are not ordered however ordering is guaranteed
 to stay the same for any particular dataset, i.e. two requests for the
 same dataset will return rows in the same order. If the dataset is
 expunged and recreated on the platform, e.g. by a re-run after an
 expired retention period, the ordering of the dataset may change.
      optional uint64 offset = 5;
      Specified by:
      getOffset in interface DataReadRequestOrBuilder
      Returns:
      The offset.

    • 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 DataReadRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DataReadRequest.Builder newBuilder()

    • newBuilder

      public static DataReadRequest.Builder newBuilder(DataReadRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DataReadRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DataReadRequest> 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 DataReadRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder