Class Data.DataRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<Data.DataRequest,Data.DataRequest.Builder>
viam.app.data.v1.Data.DataRequest.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Cloneable, Data.DataRequestOrBuilder
Enclosing class:
Data.DataRequest

public static final class Data.DataRequest.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<Data.DataRequest,Data.DataRequest.Builder> implements Data.DataRequestOrBuilder
 DataRequest encapsulates the filter for the data, a limit on the maximum results returned,
 a last string associated with the last returned document, and the sorting order by time.
 last is returned in the responses TabularDataByFilterResponse and BinaryDataByFilterResponse
 from the API calls TabularDataByFilter and BinaryDataByFilter, respectively.
 We can then use the last string from the previous API calls in the subsequent request
 to get the next set of ordered documents.
 
Protobuf type viam.app.data.v1.DataRequest
  • Method Details

    • hasFilter

      public boolean hasFilter()
      .viam.app.data.v1.Filter filter = 1 [json_name = "filter"];
      Specified by:
      hasFilter in interface Data.DataRequestOrBuilder
      Returns:
      Whether the filter field is set.
    • getFilter

      public Data.Filter getFilter()
      .viam.app.data.v1.Filter filter = 1 [json_name = "filter"];
      Specified by:
      getFilter in interface Data.DataRequestOrBuilder
      Returns:
      The filter.
    • setFilter

      public Data.DataRequest.Builder setFilter(Data.Filter value)
      .viam.app.data.v1.Filter filter = 1 [json_name = "filter"];
    • setFilter

      public Data.DataRequest.Builder setFilter(Data.Filter.Builder builderForValue)
      .viam.app.data.v1.Filter filter = 1 [json_name = "filter"];
    • mergeFilter

      public Data.DataRequest.Builder mergeFilter(Data.Filter value)
      .viam.app.data.v1.Filter filter = 1 [json_name = "filter"];
    • clearFilter

      public Data.DataRequest.Builder clearFilter()
      .viam.app.data.v1.Filter filter = 1 [json_name = "filter"];
    • getLimit

      public long getLimit()
      uint64 limit = 2 [json_name = "limit"];
      Specified by:
      getLimit in interface Data.DataRequestOrBuilder
      Returns:
      The limit.
    • setLimit

      public Data.DataRequest.Builder setLimit(long value)
      uint64 limit = 2 [json_name = "limit"];
      Parameters:
      value - The limit to set.
      Returns:
      This builder for chaining.
    • clearLimit

      public Data.DataRequest.Builder clearLimit()
      uint64 limit = 2 [json_name = "limit"];
      Returns:
      This builder for chaining.
    • getLast

      public String getLast()
      string last = 3 [json_name = "last"];
      Specified by:
      getLast in interface Data.DataRequestOrBuilder
      Returns:
      The last.
    • getLastBytes

      public com.google.protobuf.ByteString getLastBytes()
      string last = 3 [json_name = "last"];
      Specified by:
      getLastBytes in interface Data.DataRequestOrBuilder
      Returns:
      The bytes for last.
    • setLast

      public Data.DataRequest.Builder setLast(String value)
      string last = 3 [json_name = "last"];
      Parameters:
      value - The last to set.
      Returns:
      This builder for chaining.
    • clearLast

      public Data.DataRequest.Builder clearLast()
      string last = 3 [json_name = "last"];
      Returns:
      This builder for chaining.
    • setLastBytes

      public Data.DataRequest.Builder setLastBytes(com.google.protobuf.ByteString value)
      string last = 3 [json_name = "last"];
      Parameters:
      value - The bytes for last to set.
      Returns:
      This builder for chaining.
    • getSortOrderValue

      public int getSortOrderValue()
      .viam.app.data.v1.Order sort_order = 4 [json_name = "sortOrder"];
      Specified by:
      getSortOrderValue in interface Data.DataRequestOrBuilder
      Returns:
      The enum numeric value on the wire for sortOrder.
    • setSortOrderValue

      public Data.DataRequest.Builder setSortOrderValue(int value)
      .viam.app.data.v1.Order sort_order = 4 [json_name = "sortOrder"];
      Parameters:
      value - The sortOrder to set.
      Returns:
      This builder for chaining.
    • getSortOrder

      public Data.Order getSortOrder()
      .viam.app.data.v1.Order sort_order = 4 [json_name = "sortOrder"];
      Specified by:
      getSortOrder in interface Data.DataRequestOrBuilder
      Returns:
      The sortOrder.
    • setSortOrder

      public Data.DataRequest.Builder setSortOrder(Data.Order value)
      .viam.app.data.v1.Order sort_order = 4 [json_name = "sortOrder"];
      Parameters:
      value - The enum numeric value on the wire for sortOrder to set.
      Returns:
      This builder for chaining.
    • clearSortOrder

      public Data.DataRequest.Builder clearSortOrder()
      .viam.app.data.v1.Order sort_order = 4 [json_name = "sortOrder"];
      Returns:
      This builder for chaining.