// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: tracdap/api/data.proto
// Protobuf Java Version: 3.25.3
package org.finos.tracdap.api;
public interface DataReadRequestOrBuilder extends
// @@protoc_insertion_point(interface_extends:tracdap.api.DataReadRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
**
* Tenant code for the requested operation, always required.
*
*
* string tenant = 1;
* @return The tenant.
*/
java.lang.String getTenant();
/**
*
**
* Tenant code for the requested operation, always required.
*
*
* string tenant = 1;
* @return The bytes for tenant.
*/
com.google.protobuf.ByteString
getTenantBytes();
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
* @return Whether the selector field is set.
*/
boolean hasSelector();
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
* @return The selector.
*/
org.finos.tracdap.metadata.TagSelector getSelector();
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
*/
org.finos.tracdap.metadata.TagSelectorOrBuilder getSelectorOrBuilder();
/**
*
**
* 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;
* @return The format.
*/
java.lang.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;
* @return The bytes for format.
*/
com.google.protobuf.ByteString
getFormatBytes();
/**
*
**
* 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;
* @return Whether the limit field is set.
*/
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;
* @return The limit.
*/
long getLimit();
/**
*
**
* 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;
* @return Whether the offset field is set.
*/
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;
* @return The offset.
*/
long getOffset();
}
