Package org.finos.tracdap.api

Interface DataReadRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DataReadRequest, DataReadRequest.Builder
public interface DataReadRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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).
    org.finos.tracdap.metadata.TagSelector
    getSelector()
    * Selector for the dataset being read
    org.finos.tracdap.metadata.TagSelectorOrBuilder
    getSelectorOrBuilder()
    * Selector for the dataset being read
    String
    getTenant()
    * Tenant code for the requested operation, always required.
    com.google.protobuf.ByteString
    getTenantBytes()
    * Tenant code for the requested operation, always required.
    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

    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

    • getTenant

      String getTenant()
       *
 Tenant code for the requested operation, always required.
      string tenant = 1;
      Returns:
      The tenant.

    • getTenantBytes

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

    • hasSelector

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

    • getSelector

      org.finos.tracdap.metadata.TagSelector getSelector()
       *
 Selector for the dataset being read
      .tracdap.metadata.TagSelector selector = 2;
      Returns:
      The selector.

    • getSelectorOrBuilder

      org.finos.tracdap.metadata.TagSelectorOrBuilder getSelectorOrBuilder()
       *
 Selector for the dataset being read
      .tracdap.metadata.TagSelector selector = 2;

    • getFormat

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

    • getFormatBytes

      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;
      Returns:
      The bytes for format.

    • hasLimit

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

    • getLimit

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

    • hasOffset

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

    • getOffset

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