Package viam.app.data.v1

Class Data.TabularDataByMQLRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<Data.TabularDataByMQLRequest,Data.TabularDataByMQLRequest.Builder>
viam.app.data.v1.Data.TabularDataByMQLRequest
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Data.TabularDataByMQLRequestOrBuilder
Enclosing class:
Data
public static final class Data.TabularDataByMQLRequest extends com.google.protobuf.GeneratedMessageLite<Data.TabularDataByMQLRequest,Data.TabularDataByMQLRequest.Builder> implements Data.TabularDataByMQLRequestOrBuilder
 TabularDataByMQLRequest requests tabular data using an MQL query.
Protobuf type viam.app.data.v1.TabularDataByMQLRequest

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Data.TabularDataByMQLRequest.Builder
    TabularDataByMQLRequest requests tabular data using an MQL query.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DATA_SOURCE_FIELD_NUMBER
     
    static final int
    MQL_BINARY_FIELD_NUMBER
     
    static final int
    ORGANIZATION_ID_FIELD_NUMBER
     
    static final int
    QUERY_PREFIX_NAME_FIELD_NUMBER
     
    static final int
    USE_RECENT_DATA_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    Data.TabularDataSource
    getDataSource()
    data_source is an optional field that can be used to specify the data source for the query.
    static Data.TabularDataByMQLRequest
    getDefaultInstance()
     
    com.google.protobuf.ByteString
    getMqlBinary(int index)
    mql_binary accepts a MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline.
    int
    getMqlBinaryCount()
    mql_binary accepts a MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline.
    List<com.google.protobuf.ByteString>
    getMqlBinaryList()
    mql_binary accepts a MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline.
    String
    getOrganizationId()
    string organization_id = 1 [json_name = "organizationId"];
    com.google.protobuf.ByteString
    getOrganizationIdBytes()
    string organization_id = 1 [json_name = "organizationId"];
    String
    getQueryPrefixName()
    query_prefix_name is an optional field that can be used to specify a saved query to run
    com.google.protobuf.ByteString
    getQueryPrefixNameBytes()
    query_prefix_name is an optional field that can be used to specify a saved query to run
    boolean
    getUseRecentData()
    Deprecated, please use TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE instead.
    boolean
    hasDataSource()
    data_source is an optional field that can be used to specify the data source for the query.
    boolean
    hasQueryPrefixName()
    query_prefix_name is an optional field that can be used to specify a saved query to run
    boolean
    hasUseRecentData()
    Deprecated, please use TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE instead.
    static Data.TabularDataByMQLRequest.Builder
    newBuilder()
     
    static Data.TabularDataByMQLRequest.Builder
    newBuilder(Data.TabularDataByMQLRequest prototype)
     
    static Data.TabularDataByMQLRequest
    parseDelimitedFrom(InputStream input)
     
    static Data.TabularDataByMQLRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Data.TabularDataByMQLRequest
    parseFrom(byte[] data)
     
    static Data.TabularDataByMQLRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Data.TabularDataByMQLRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static Data.TabularDataByMQLRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Data.TabularDataByMQLRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Data.TabularDataByMQLRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Data.TabularDataByMQLRequest
    parseFrom(InputStream input)
     
    static Data.TabularDataByMQLRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Data.TabularDataByMQLRequest
    parseFrom(ByteBuffer data)
     
    static Data.TabularDataByMQLRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Data.TabularDataByMQLRequest>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

    • ORGANIZATION_ID_FIELD_NUMBER

      public static final int ORGANIZATION_ID_FIELD_NUMBER
      See Also:

    • MQL_BINARY_FIELD_NUMBER

      public static final int MQL_BINARY_FIELD_NUMBER
      See Also:

    • USE_RECENT_DATA_FIELD_NUMBER

      public static final int USE_RECENT_DATA_FIELD_NUMBER
      See Also:

    • DATA_SOURCE_FIELD_NUMBER

      public static final int DATA_SOURCE_FIELD_NUMBER
      See Also:

    • QUERY_PREFIX_NAME_FIELD_NUMBER

      public static final int QUERY_PREFIX_NAME_FIELD_NUMBER
      See Also:

  • Method Details

    • getOrganizationId

      public String getOrganizationId()
      string organization_id = 1 [json_name = "organizationId"];
      Specified by:
      getOrganizationId in interface Data.TabularDataByMQLRequestOrBuilder
      Returns:
      The organizationId.

    • getOrganizationIdBytes

      public com.google.protobuf.ByteString getOrganizationIdBytes()
      string organization_id = 1 [json_name = "organizationId"];
      Specified by:
      getOrganizationIdBytes in interface Data.TabularDataByMQLRequestOrBuilder
      Returns:
      The bytes for organizationId.

    • getMqlBinaryList

      public List<com.google.protobuf.ByteString> getMqlBinaryList()
       mql_binary accepts a MongoDB aggregation pipeline as a list of BSON documents, where each
 document is one stage in the pipeline. The pipeline is run on the "sensorData.readings"
 namespace, which holds the Viam organization's tabular data.
      repeated bytes mql_binary = 3 [json_name = "mqlBinary"];
      Specified by:
      getMqlBinaryList in interface Data.TabularDataByMQLRequestOrBuilder
      Returns:
      A list containing the mqlBinary.

    • getMqlBinaryCount

      public int getMqlBinaryCount()
       mql_binary accepts a MongoDB aggregation pipeline as a list of BSON documents, where each
 document is one stage in the pipeline. The pipeline is run on the "sensorData.readings"
 namespace, which holds the Viam organization's tabular data.
      repeated bytes mql_binary = 3 [json_name = "mqlBinary"];
      Specified by:
      getMqlBinaryCount in interface Data.TabularDataByMQLRequestOrBuilder
      Returns:
      The count of mqlBinary.

    • getMqlBinary

      public com.google.protobuf.ByteString getMqlBinary(int index)
       mql_binary accepts a MongoDB aggregation pipeline as a list of BSON documents, where each
 document is one stage in the pipeline. The pipeline is run on the "sensorData.readings"
 namespace, which holds the Viam organization's tabular data.
      repeated bytes mql_binary = 3 [json_name = "mqlBinary"];
      Specified by:
      getMqlBinary in interface Data.TabularDataByMQLRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The mqlBinary at the given index.

    • hasUseRecentData

      public boolean hasUseRecentData()
       Deprecated, please use TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE instead.
      optional bool use_recent_data = 4 [json_name = "useRecentData"];
      Specified by:
      hasUseRecentData in interface Data.TabularDataByMQLRequestOrBuilder
      Returns:
      Whether the useRecentData field is set.

    • getUseRecentData

      public boolean getUseRecentData()
       Deprecated, please use TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE instead.
      optional bool use_recent_data = 4 [json_name = "useRecentData"];
      Specified by:
      getUseRecentData in interface Data.TabularDataByMQLRequestOrBuilder
      Returns:
      The useRecentData.

    • hasDataSource

      public boolean hasDataSource()
       data_source is an optional field that can be used to specify the data source for the query.
 If not specified, the query will run on "standard" storage.
      optional .viam.app.data.v1.TabularDataSource data_source = 6 [json_name = "dataSource"];
      Specified by:
      hasDataSource in interface Data.TabularDataByMQLRequestOrBuilder
      Returns:
      Whether the dataSource field is set.

    • getDataSource

      public Data.TabularDataSource getDataSource()
       data_source is an optional field that can be used to specify the data source for the query.
 If not specified, the query will run on "standard" storage.
      optional .viam.app.data.v1.TabularDataSource data_source = 6 [json_name = "dataSource"];
      Specified by:
      getDataSource in interface Data.TabularDataByMQLRequestOrBuilder
      Returns:
      The dataSource.

    • hasQueryPrefixName

      public boolean hasQueryPrefixName()
       query_prefix_name is an optional field that can be used to specify a saved query to run
      optional string query_prefix_name = 7 [json_name = "queryPrefixName"];
      Specified by:
      hasQueryPrefixName in interface Data.TabularDataByMQLRequestOrBuilder
      Returns:
      Whether the queryPrefixName field is set.

    • getQueryPrefixName

      public String getQueryPrefixName()
       query_prefix_name is an optional field that can be used to specify a saved query to run
      optional string query_prefix_name = 7 [json_name = "queryPrefixName"];
      Specified by:
      getQueryPrefixName in interface Data.TabularDataByMQLRequestOrBuilder
      Returns:
      The queryPrefixName.

    • getQueryPrefixNameBytes

      public com.google.protobuf.ByteString getQueryPrefixNameBytes()
       query_prefix_name is an optional field that can be used to specify a saved query to run
      optional string query_prefix_name = 7 [json_name = "queryPrefixName"];
      Specified by:
      getQueryPrefixNameBytes in interface Data.TabularDataByMQLRequestOrBuilder
      Returns:
      The bytes for queryPrefixName.

    • parseFrom

      public static Data.TabularDataByMQLRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Data.TabularDataByMQLRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Data.TabularDataByMQLRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Data.TabularDataByMQLRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Data.TabularDataByMQLRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Data.TabularDataByMQLRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Data.TabularDataByMQLRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Data.TabularDataByMQLRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Data.TabularDataByMQLRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Data.TabularDataByMQLRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Data.TabularDataByMQLRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Data.TabularDataByMQLRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static Data.TabularDataByMQLRequest.Builder newBuilder()

    • newBuilder

      public static Data.TabularDataByMQLRequest.Builder newBuilder(Data.TabularDataByMQLRequest prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<Data.TabularDataByMQLRequest,Data.TabularDataByMQLRequest.Builder>

    • getDefaultInstance

      public static Data.TabularDataByMQLRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Data.TabularDataByMQLRequest> parser()