Package viam.app.data.v1
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-
Field Summary
Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder
instance -
Method Summary
Modifier and TypeMethodDescription.viam.app.data.v1.Filter filter = 1 [json_name = "filter"];string last = 3 [json_name = "last"];uint64 limit = 2 [json_name = "limit"];.viam.app.data.v1.Order sort_order = 4 [json_name = "sortOrder"];.viam.app.data.v1.Filter filter = 1 [json_name = "filter"];getLast()string last = 3 [json_name = "last"];com.google.protobuf.ByteStringstring last = 3 [json_name = "last"];longgetLimit()uint64 limit = 2 [json_name = "limit"];.viam.app.data.v1.Order sort_order = 4 [json_name = "sortOrder"];int.viam.app.data.v1.Order sort_order = 4 [json_name = "sortOrder"];boolean.viam.app.data.v1.Filter filter = 1 [json_name = "filter"];mergeFilter(Data.Filter value) .viam.app.data.v1.Filter filter = 1 [json_name = "filter"];setFilter(Data.Filter value) .viam.app.data.v1.Filter filter = 1 [json_name = "filter"];setFilter(Data.Filter.Builder builderForValue) .viam.app.data.v1.Filter filter = 1 [json_name = "filter"];string last = 3 [json_name = "last"];setLastBytes(com.google.protobuf.ByteString value) string last = 3 [json_name = "last"];setLimit(long value) uint64 limit = 2 [json_name = "limit"];setSortOrder(Data.Order value) .viam.app.data.v1.Order sort_order = 4 [json_name = "sortOrder"];setSortOrderValue(int value) .viam.app.data.v1.Order sort_order = 4 [json_name = "sortOrder"];Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFromMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Method Details
-
hasFilter
public boolean hasFilter().viam.app.data.v1.Filter filter = 1 [json_name = "filter"];- Specified by:
hasFilterin interfaceData.DataRequestOrBuilder- Returns:
- Whether the filter field is set.
-
getFilter
.viam.app.data.v1.Filter filter = 1 [json_name = "filter"];- Specified by:
getFilterin interfaceData.DataRequestOrBuilder- Returns:
- The filter.
-
setFilter
.viam.app.data.v1.Filter filter = 1 [json_name = "filter"]; -
setFilter
.viam.app.data.v1.Filter filter = 1 [json_name = "filter"]; -
mergeFilter
.viam.app.data.v1.Filter filter = 1 [json_name = "filter"]; -
clearFilter
.viam.app.data.v1.Filter filter = 1 [json_name = "filter"]; -
getLimit
public long getLimit()uint64 limit = 2 [json_name = "limit"];- Specified by:
getLimitin interfaceData.DataRequestOrBuilder- Returns:
- The limit.
-
setLimit
uint64 limit = 2 [json_name = "limit"];- Parameters:
value- The limit to set.- Returns:
- This builder for chaining.
-
clearLimit
uint64 limit = 2 [json_name = "limit"];- Returns:
- This builder for chaining.
-
getLast
string last = 3 [json_name = "last"];- Specified by:
getLastin interfaceData.DataRequestOrBuilder- Returns:
- The last.
-
getLastBytes
public com.google.protobuf.ByteString getLastBytes()string last = 3 [json_name = "last"];- Specified by:
getLastBytesin interfaceData.DataRequestOrBuilder- Returns:
- The bytes for last.
-
setLast
string last = 3 [json_name = "last"];- Parameters:
value- The last to set.- Returns:
- This builder for chaining.
-
clearLast
string last = 3 [json_name = "last"];- Returns:
- This builder for chaining.
-
setLastBytes
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:
getSortOrderValuein interfaceData.DataRequestOrBuilder- Returns:
- The enum numeric value on the wire for sortOrder.
-
setSortOrderValue
.viam.app.data.v1.Order sort_order = 4 [json_name = "sortOrder"];- Parameters:
value- The sortOrder to set.- Returns:
- This builder for chaining.
-
getSortOrder
.viam.app.data.v1.Order sort_order = 4 [json_name = "sortOrder"];- Specified by:
getSortOrderin interfaceData.DataRequestOrBuilder- Returns:
- The sortOrder.
-
setSortOrder
.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
.viam.app.data.v1.Order sort_order = 4 [json_name = "sortOrder"];- Returns:
- This builder for chaining.
-