Package org.finos.tracdap.api

Class DataReadRequest.Builder

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

 @see TracDataApi.readDataset
Protobuf type tracdap.api.DataReadRequest

  • Method Summary

    Modifier and Type
    Method
    Description
    DataReadRequest
    build()
     
    DataReadRequest
    buildPartial()
     
    DataReadRequest.Builder
    clear()
     
    DataReadRequest.Builder
    clearFormat()
    * Format that the dataset will be returned in.
    DataReadRequest.Builder
    clearLimit()
    * Limit the number of rows returned by the request (optional).
    DataReadRequest.Builder
    clearOffset()
    * Read dataset starting at the row with the given offset (optional).
    DataReadRequest.Builder
    clearSelector()
    * Selector for the dataset being read
    DataReadRequest.Builder
    clearTenant()
    * Tenant code for the requested operation, always required.
    DataReadRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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.TagSelector.Builder
    getSelectorBuilder()
    * 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
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    DataReadRequest.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    DataReadRequest.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    DataReadRequest.Builder
    mergeFrom(DataReadRequest other)
     
    DataReadRequest.Builder
    mergeSelector(org.finos.tracdap.metadata.TagSelector value)
    * Selector for the dataset being read
    DataReadRequest.Builder
    setFormat(String value)
    * Format that the dataset will be returned in.
    DataReadRequest.Builder
    setFormatBytes(com.google.protobuf.ByteString value)
    * Format that the dataset will be returned in.
    DataReadRequest.Builder
    setLimit(long value)
    * Limit the number of rows returned by the request (optional).
    DataReadRequest.Builder
    setOffset(long value)
    * Read dataset starting at the row with the given offset (optional).
    DataReadRequest.Builder
    setSelector(org.finos.tracdap.metadata.TagSelector value)
    * Selector for the dataset being read
    DataReadRequest.Builder
    setSelector(org.finos.tracdap.metadata.TagSelector.Builder builderForValue)
    * Selector for the dataset being read
    DataReadRequest.Builder
    setTenant(String value)
    * Tenant code for the requested operation, always required.
    DataReadRequest.Builder
    setTenantBytes(com.google.protobuf.ByteString value)
    * Tenant code for the requested operation, always required.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • 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.Builder<DataReadRequest.Builder>

    • clear

      public DataReadRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<DataReadRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<DataReadRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public DataReadRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DataReadRequest.Builder>

    • mergeFrom

      public DataReadRequest.Builder mergeFrom(DataReadRequest other)

    • isInitialized

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

    • mergeFrom

      public DataReadRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DataReadRequest.Builder>
      Throws:
      IOException

    • 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.

    • setTenant

      public DataReadRequest.Builder setTenant(String value)
       *
 Tenant code for the requested operation, always required.
      string tenant = 1;
      Parameters:
      value - The tenant to set.
      Returns:
      This builder for chaining.

    • clearTenant

      public DataReadRequest.Builder clearTenant()
       *
 Tenant code for the requested operation, always required.
      string tenant = 1;
      Returns:
      This builder for chaining.

    • setTenantBytes

      public DataReadRequest.Builder setTenantBytes(com.google.protobuf.ByteString value)
       *
 Tenant code for the requested operation, always required.
      string tenant = 1;
      Parameters:
      value - The bytes for tenant to set.
      Returns:
      This builder for chaining.

    • 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.

    • setSelector

      public DataReadRequest.Builder setSelector(org.finos.tracdap.metadata.TagSelector value)
       *
 Selector for the dataset being read
      .tracdap.metadata.TagSelector selector = 2;

    • setSelector

      public DataReadRequest.Builder setSelector(org.finos.tracdap.metadata.TagSelector.Builder builderForValue)
       *
 Selector for the dataset being read
      .tracdap.metadata.TagSelector selector = 2;

    • mergeSelector

      public DataReadRequest.Builder mergeSelector(org.finos.tracdap.metadata.TagSelector value)
       *
 Selector for the dataset being read
      .tracdap.metadata.TagSelector selector = 2;

    • clearSelector

      public DataReadRequest.Builder clearSelector()
       *
 Selector for the dataset being read
      .tracdap.metadata.TagSelector selector = 2;

    • getSelectorBuilder

      public org.finos.tracdap.metadata.TagSelector.Builder getSelectorBuilder()
       *
 Selector for the dataset being read
      .tracdap.metadata.TagSelector selector = 2;

    • 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.

    • setFormat

      public DataReadRequest.Builder setFormat(String value)
       *
 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;
      Parameters:
      value - The format to set.
      Returns:
      This builder for chaining.

    • clearFormat

      public DataReadRequest.Builder clearFormat()
       *
 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:
      This builder for chaining.

    • setFormatBytes

      public DataReadRequest.Builder setFormatBytes(com.google.protobuf.ByteString value)
       *
 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;
      Parameters:
      value - The bytes for format to set.
      Returns:
      This builder for chaining.

    • 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.

    • setLimit

      public DataReadRequest.Builder setLimit(long value)
       *
 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;
      Parameters:
      value - The limit to set.
      Returns:
      This builder for chaining.

    • clearLimit

      public DataReadRequest.Builder clearLimit()
       *
 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:
      This builder for chaining.

    • 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.

    • setOffset

      public DataReadRequest.Builder setOffset(long value)
       *
 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;
      Parameters:
      value - The offset to set.
      Returns:
      This builder for chaining.

    • clearOffset

      public DataReadRequest.Builder clearOffset()
       *
 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:
      This builder for chaining.