viam-sdk 0.47.0__py3-none-win_amd64.whl → 0.49.0__py3-none-win_amd64.whl

viam/app/data_client.py

@@ -270,6 +270,9 @@ class DataClient:
         enabled: bool
         """Whether the data pipeline is enabled"""
 
+        data_source_type: TabularDataSourceType.ValueType
+        """The type of data source for the data pipeline"""
+
         @classmethod
         def from_proto(cls, data_pipeline: ProtoDataPipeline) -> Self:
             return cls(
@@ -281,6 +284,7 @@ class DataClient:
                 created_on=data_pipeline.created_on.ToDatetime(),
                 updated_at=data_pipeline.updated_at.ToDatetime(),
                 enabled=data_pipeline.enabled,
+                data_source_type=data_pipeline.data_source_type,
             )
 
     @dataclass
@@ -1883,7 +1887,14 @@ class DataClient:
         response: ListDataPipelinesResponse = await self._data_pipelines_client.ListDataPipelines(request, metadata=self._metadata)
         return [DataClient.DataPipeline.from_proto(pipeline) for pipeline in response.data_pipelines]
 
-    async def create_data_pipeline(self, organization_id: str, name: str, mql_binary: List[Dict[str, Any]], schedule: str) -> str:
+    async def create_data_pipeline(
+        self,
+        organization_id: str,
+        name: str,
+        mql_binary: List[Dict[str, Any]],
+        schedule: str,
+        data_source_type: TabularDataSourceType.ValueType = TabularDataSourceType.TABULAR_DATA_SOURCE_TYPE_STANDARD,
+    ) -> str:
         """Create a new data pipeline.
 
         ::
@@ -1892,7 +1903,8 @@ class DataClient:
                 organization_id="<YOUR-ORGANIZATION-ID>",
                 name="<YOUR-PIPELINE-NAME>",
                 mql_binary=[<YOUR-MQL-PIPELINE-AGGREGATION>],
-                schedule="<YOUR-SCHEDULE>"
+                schedule="<YOUR-SCHEDULE>",
+                data_source_type=TabularDataSourceType.TABULAR_DATA_SOURCE_TYPE_STANDARD,
             )
 
         Args:
@@ -1902,12 +1914,16 @@ class DataClient:
             mql_binary (List[Dict[str, Any]]):The MQL pipeline to run, as a list of MongoDB aggregation pipeline stages.
             schedule (str): A cron expression representing the expected execution schedule in UTC (note this also
                 defines the input time window; an hourly schedule would process 1 hour of data at a time).
+            data_source_type (TabularDataSourceType): The type of data source to use for the pipeline.
+                Defaults to TabularDataSourceType.TABULAR_DATA_SOURCE_TYPE_STANDARD.
 
         Returns:
             str: The ID of the newly created pipeline.
         """
         binary: List[bytes] = [bson.encode(query) for query in mql_binary]
-        request = CreateDataPipelineRequest(organization_id=organization_id, name=name, mql_binary=binary, schedule=schedule)
+        request = CreateDataPipelineRequest(
+            organization_id=organization_id, name=name, mql_binary=binary, schedule=schedule, data_source_type=data_source_type
+        )
         response: CreateDataPipelineResponse = await self._data_pipelines_client.CreateDataPipeline(request, metadata=self._metadata)
         return response.id
 

viam/components/arm/arm.py

@@ -194,7 +194,7 @@ class Arm(ComponentBase):
 
     @abc.abstractmethod
     async def get_kinematics(
-        self, *, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None
+        self, *, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs
     ) -> Tuple[KinematicsFileFormat.ValueType, bytes]:
         """
         Get the kinematics information associated with the arm.

viam/components/gripper/__init__.py

@@ -1,3 +1,4 @@
+from viam.proto.common import KinematicsFileFormat
 from viam.resource.registry import Registry, ResourceRegistration
 
 from .client import GripperClient
@@ -6,6 +7,7 @@ from .service import GripperRPCService
 
 __all__ = [
     "Gripper",
+    "KinematicsFileFormat",
 ]
 
 Registry.register_api(ResourceRegistration(Gripper, GripperRPCService, lambda name, channel: GripperClient(name, channel)))

viam/components/gripper/client.py

@@ -1,12 +1,14 @@
-from typing import Any, Dict, List, Mapping, Optional
+from typing import Any, Dict, List, Mapping, Optional, Tuple
 
 from grpclib.client import Channel
 
-from viam.proto.common import DoCommandRequest, DoCommandResponse, Geometry
+from viam.proto.common import DoCommandRequest, DoCommandResponse, Geometry, GetKinematicsRequest, GetKinematicsResponse
 from viam.proto.component.gripper import (
     GrabRequest,
     GrabResponse,
     GripperServiceStub,
+    IsHoldingSomethingRequest,
+    IsHoldingSomethingResponse,
     IsMovingRequest,
     IsMovingResponse,
     OpenRequest,
@@ -15,6 +17,7 @@ from viam.proto.component.gripper import (
 from viam.resource.rpc_client_base import ReconfigurableResourceRPCClientBase
 from viam.utils import ValueTypes, dict_to_struct, get_geometries, struct_to_dict
 
+from . import KinematicsFileFormat
 from .gripper import Gripper
 
 
@@ -62,6 +65,14 @@ class GripperClient(Gripper, ReconfigurableResourceRPCClientBase):
         request = StopRequest(name=self.name, extra=dict_to_struct(extra))
         await self.client.Stop(request, timeout=timeout, metadata=md)
 
+    async def is_holding_something(
+        self, *, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs
+    ) -> Gripper.HoldingStatus:
+        md = kwargs.get("metadata", self.Metadata()).proto
+        request = IsHoldingSomethingRequest(name=self.name, extra=dict_to_struct(extra))
+        response: IsHoldingSomethingResponse = await self.client.IsHoldingSomething(request, timeout=timeout, metadata=md)
+        return Gripper.HoldingStatus(response.is_holding_something, meta=struct_to_dict(response.meta))
+
     async def is_moving(self, *, timeout: Optional[float] = None, **kwargs) -> bool:
         md = kwargs.get("metadata", self.Metadata()).proto
         request = IsMovingRequest(name=self.name)
@@ -83,3 +94,15 @@ class GripperClient(Gripper, ReconfigurableResourceRPCClientBase):
     async def get_geometries(self, *, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs) -> List[Geometry]:
         md = kwargs.get("metadata", self.Metadata())
         return await get_geometries(self.client, self.name, extra, timeout, md)
+
+    async def get_kinematics(
+        self,
+        *,
+        extra: Optional[Dict[str, Any]] = None,
+        timeout: Optional[float] = None,
+        **kwargs,
+    ) -> Tuple[KinematicsFileFormat.ValueType, bytes]:
+        md = kwargs.get("metadata", self.Metadata()).proto
+        request = GetKinematicsRequest(name=self.name, extra=dict_to_struct(extra))
+        response: GetKinematicsResponse = await self.client.GetKinematics(request, timeout=timeout, metadata=md)
+        return (response.format, response.kinematics_data)

viam/components/gripper/gripper.py

@@ -1,9 +1,12 @@
 import abc
-from typing import Any, Dict, Final, Optional
+from dataclasses import dataclass
+from typing import Any, Dict, Final, Optional, Tuple
 
 from viam.components.component_base import ComponentBase
 from viam.resource.types import API, RESOURCE_NAMESPACE_RDK, RESOURCE_TYPE_COMPONENT
 
+from . import KinematicsFileFormat
+
 
 class Gripper(ComponentBase):
     """
@@ -24,6 +27,17 @@ class Gripper(ComponentBase):
         RESOURCE_NAMESPACE_RDK, RESOURCE_TYPE_COMPONENT, "gripper"
     )
 
+    @dataclass
+    class HoldingStatus:
+        """
+        HoldingStatus represents whether the gripper is currently holding onto an object. The
+        additional ``meta`` attribute contains other optional contextual information (i.e. confidence
+        interval, pressure, etc.)
+        """
+
+        is_holding_something: bool
+        meta: Optional[Dict[str, Any]] = None
+
     @abc.abstractmethod
     async def open(
         self,
@@ -71,6 +85,33 @@ class Gripper(ComponentBase):
         """
         ...
 
+    @abc.abstractmethod
+    async def is_holding_something(
+        self,
+        *,
+        extra: Optional[Dict[str, Any]] = None,
+        timeout: Optional[float] = None,
+        **kwargs,
+    ) -> HoldingStatus:
+        """
+        Get information about whether the gripper is currently holding onto an object.
+
+        ::
+
+            my_gripper = Gripper.from_robot(robot=machine, name="my_gripper")
+
+            # Grab with the gripper.
+            holding_status = await my_gripper.is_holding_something()
+            # get the boolean result
+            is_holding_something = holding_status.is_holding_something
+
+        Returns:
+            HoldingStatus: see documentation on `HoldingStatus` for more information
+
+        For more information, see `Gripper component <https://docs.viam.com/dev/reference/apis/components/gripper/#grab>`_.
+
+        """
+
     @abc.abstractmethod
     async def stop(
         self,
@@ -112,3 +153,37 @@ class Gripper(ComponentBase):
         For more information, see `Gripper component <https://docs.viam.com/dev/reference/apis/components/gripper/#is_moving>`_.
         """
         ...
+
+    @abc.abstractmethod
+    async def get_kinematics(
+        self,
+        *,
+        extra: Optional[Dict[str, Any]] = None,
+        timeout: Optional[float] = None,
+        **kwargs,
+    ) -> Tuple[KinematicsFileFormat.ValueType, bytes]:
+        """
+        Get the kinematics information associated with the gripper.
+
+        ::
+
+            my_gripper = Gripper.from_robot(robot=machine, name="my_gripper")
+
+            # Get the kinematics information associated with the gripper.
+            kinematics = await my_gripper.get_kinematics()
+
+            # Get the format of the kinematics file.
+            k_file = kinematics[0]
+
+            # Get the byte contents of the file.
+            k_bytes = kinematics[1]
+
+        Returns:
+            Tuple[KinematicsFileFormat.ValueType, bytes]: A tuple containing two values; the first [0] value represents the format of the
+            file, either in URDF format (``KinematicsFileFormat.KINEMATICS_FILE_FORMAT_URDF``) or
+            Viam's kinematic parameter format (spatial vector algebra) (``KinematicsFileFormat.KINEMATICS_FILE_FORMAT_SVA``),
+            and the second [1] value represents the byte contents of the file.
+
+        For more information, see `Gripper component <https://docs.viam.com/dev/reference/apis/components/gripper/#getkinematics>`_.
+        """
+        ...

viam/components/gripper/service.py

@@ -1,10 +1,19 @@
 from grpclib.server import Stream
 
-from viam.proto.common import DoCommandRequest, DoCommandResponse, GetGeometriesRequest, GetGeometriesResponse
+from viam.proto.common import (
+    DoCommandRequest,
+    DoCommandResponse,
+    GetGeometriesRequest,
+    GetGeometriesResponse,
+    GetKinematicsRequest,
+    GetKinematicsResponse,
+)
 from viam.proto.component.gripper import (
     GrabRequest,
     GrabResponse,
     GripperServiceBase,
+    IsHoldingSomethingRequest,
+    IsHoldingSomethingResponse,
     IsMovingRequest,
     IsMovingResponse,
     OpenRequest,
@@ -62,6 +71,17 @@ class GripperRPCService(GripperServiceBase, ResourceRPCServiceBase[Gripper]):
         response = IsMovingResponse(is_moving=is_moving)
         await stream.send_message(response)
 
+    async def IsHoldingSomething(self, stream: Stream[IsHoldingSomethingRequest, IsHoldingSomethingResponse]) -> None:
+        request = await stream.recv_message()
+        assert request is not None
+        name = request.name
+        gripper = self.get_resource(name)
+        holding_status = await gripper.is_holding_something()
+        response = IsHoldingSomethingResponse(
+            is_holding_something=holding_status.is_holding_something, meta=dict_to_struct(holding_status.meta)
+        )
+        await stream.send_message(response)
+
     async def DoCommand(self, stream: Stream[DoCommandRequest, DoCommandResponse]) -> None:
         request = await stream.recv_message()
         assert request is not None
@@ -74,8 +94,17 @@ class GripperRPCService(GripperServiceBase, ResourceRPCServiceBase[Gripper]):
     async def GetGeometries(self, stream: Stream[GetGeometriesRequest, GetGeometriesResponse]) -> None:
         request = await stream.recv_message()
         assert request is not None
-        arm = self.get_resource(request.name)
+        gripper = self.get_resource(request.name)
         timeout = stream.deadline.time_remaining() if stream.deadline else None
-        geometries = await arm.get_geometries(extra=struct_to_dict(request.extra), timeout=timeout)
+        geometries = await gripper.get_geometries(extra=struct_to_dict(request.extra), timeout=timeout)
         response = GetGeometriesResponse(geometries=geometries)
         await stream.send_message(response)
+
+    async def GetKinematics(self, stream: Stream[GetKinematicsRequest, GetKinematicsResponse]) -> None:
+        request = await stream.recv_message()
+        assert request is not None
+        gripper = self.get_resource(request.name)
+        timeout = stream.deadline.time_remaining() if stream.deadline else None
+        format, kinematics_data = await gripper.get_kinematics(extra=struct_to_dict(request.extra), timeout=timeout)
+        response = GetKinematicsResponse(format=format, kinematics_data=kinematics_data)
+        await stream.send_message(response)

viam/gen/app/datapipelines/v1/data_pipelines_grpc.py

@@ -5,8 +5,8 @@ import grpclib.client
 import grpclib.exceptions
 if typing.TYPE_CHECKING:
     import grpclib.server
-import google.protobuf.timestamp_pb2
 from .... import app
+import google.protobuf.timestamp_pb2
 
 class DataPipelinesServiceBase(abc.ABC):
 

viam/gen/app/datapipelines/v1/data_pipelines_pb2.py

@@ -6,51 +6,52 @@ from google.protobuf import symbol_database as _symbol_database
 from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(_runtime_version.Domain.PUBLIC, 5, 29, 2, '', 'app/datapipelines/v1/data_pipelines.proto')
 _sym_db = _symbol_database.Default()
+from ....app.data.v1 import data_pb2 as app_dot_data_dot_v1_dot_data__pb2
 from google.protobuf import timestamp_pb2 as google_dot_protobuf_dot_timestamp__pb2
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n)app/datapipelines/v1/data_pipelines.proto\x12\x19viam.app.datapipelines.v1\x1a\x1fgoogle/protobuf/timestamp.proto"\xa6\x02\n\x0cDataPipeline\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id\x12\'\n\x0forganization_id\x18\x02 \x01(\tR\x0eorganizationId\x12\x12\n\x04name\x18\x03 \x01(\tR\x04name\x12\x1d\n\nmql_binary\x18\x04 \x03(\x0cR\tmqlBinary\x12\x1a\n\x08schedule\x18\x05 \x01(\tR\x08schedule\x12\x18\n\x07enabled\x18\x06 \x01(\x08R\x07enabled\x129\n\ncreated_on\x18\x07 \x01(\x0b2\x1a.google.protobuf.TimestampR\tcreatedOn\x129\n\nupdated_at\x18\x08 \x01(\x0b2\x1a.google.protobuf.TimestampR\tupdatedAt"(\n\x16GetDataPipelineRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"g\n\x17GetDataPipelineResponse\x12L\n\rdata_pipeline\x18\x01 \x01(\x0b2\'.viam.app.datapipelines.v1.DataPipelineR\x0cdataPipeline"C\n\x18ListDataPipelinesRequest\x12\'\n\x0forganization_id\x18\x01 \x01(\tR\x0eorganizationId"k\n\x19ListDataPipelinesResponse\x12N\n\x0edata_pipelines\x18\x01 \x03(\x0b2\'.viam.app.datapipelines.v1.DataPipelineR\rdataPipelines"\x93\x01\n\x19CreateDataPipelineRequest\x12\'\n\x0forganization_id\x18\x01 \x01(\tR\x0eorganizationId\x12\x12\n\x04name\x18\x02 \x01(\tR\x04name\x12\x1d\n\nmql_binary\x18\x03 \x03(\x0cR\tmqlBinary\x12\x1a\n\x08schedule\x18\x04 \x01(\tR\x08schedule",\n\x1aCreateDataPipelineResponse\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"z\n\x19UpdateDataPipelineRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id\x12\x12\n\x04name\x18\x02 \x01(\tR\x04name\x12\x1d\n\nmql_binary\x18\x03 \x03(\x0cR\tmqlBinary\x12\x1a\n\x08schedule\x18\x04 \x01(\tR\x08schedule"\x1c\n\x1aUpdateDataPipelineResponse"+\n\x19DeleteDataPipelineRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"\x1c\n\x1aDeleteDataPipelineResponse"+\n\x19EnableDataPipelineRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"\x1c\n\x1aEnableDataPipelineResponse",\n\x1aDisableDataPipelineRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"\x1d\n\x1bDisableDataPipelineResponse"i\n\x1bListDataPipelineRunsRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id\x12\x1b\n\tpage_size\x18\x02 \x01(\rR\x08pageSize\x12\x1d\n\npage_token\x18\x03 \x01(\tR\tpageToken"\xa7\x01\n\x1cListDataPipelineRunsResponse\x12\x1f\n\x0bpipeline_id\x18\x01 \x01(\tR\npipelineId\x12>\n\x04runs\x18\x02 \x03(\x0b2*.viam.app.datapipelines.v1.DataPipelineRunR\x04runs\x12&\n\x0fnext_page_token\x18\x03 \x01(\tR\rnextPageToken"\xe1\x02\n\x0fDataPipelineRun\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id\x129\n\nstart_time\x18\x02 \x01(\x0b2\x1a.google.protobuf.TimestampR\tstartTime\x125\n\x08end_time\x18\x03 \x01(\x0b2\x1a.google.protobuf.TimestampR\x07endTime\x12B\n\x0fdata_start_time\x18\x04 \x01(\x0b2\x1a.google.protobuf.TimestampR\rdataStartTime\x12>\n\rdata_end_time\x18\x05 \x01(\x0b2\x1a.google.protobuf.TimestampR\x0bdataEndTime\x12H\n\x06status\x18\x06 \x01(\x0e20.viam.app.datapipelines.v1.DataPipelineRunStatusR\x06status*\xdc\x01\n\x15DataPipelineRunStatus\x12(\n$DATA_PIPELINE_RUN_STATUS_UNSPECIFIED\x10\x00\x12&\n"DATA_PIPELINE_RUN_STATUS_SCHEDULED\x10\x01\x12$\n DATA_PIPELINE_RUN_STATUS_STARTED\x10\x02\x12&\n"DATA_PIPELINE_RUN_STATUS_COMPLETED\x10\x03\x12#\n\x1fDATA_PIPELINE_RUN_STATUS_FAILED\x10\x042\xb1\x08\n\x14DataPipelinesService\x12x\n\x0fGetDataPipeline\x121.viam.app.datapipelines.v1.GetDataPipelineRequest\x1a2.viam.app.datapipelines.v1.GetDataPipelineResponse\x12~\n\x11ListDataPipelines\x123.viam.app.datapipelines.v1.ListDataPipelinesRequest\x1a4.viam.app.datapipelines.v1.ListDataPipelinesResponse\x12\x81\x01\n\x12CreateDataPipeline\x124.viam.app.datapipelines.v1.CreateDataPipelineRequest\x1a5.viam.app.datapipelines.v1.CreateDataPipelineResponse\x12\x81\x01\n\x12UpdateDataPipeline\x124.viam.app.datapipelines.v1.UpdateDataPipelineRequest\x1a5.viam.app.datapipelines.v1.UpdateDataPipelineResponse\x12\x81\x01\n\x12DeleteDataPipeline\x124.viam.app.datapipelines.v1.DeleteDataPipelineRequest\x1a5.viam.app.datapipelines.v1.DeleteDataPipelineResponse\x12\x81\x01\n\x12EnableDataPipeline\x124.viam.app.datapipelines.v1.EnableDataPipelineRequest\x1a5.viam.app.datapipelines.v1.EnableDataPipelineResponse\x12\x84\x01\n\x13DisableDataPipeline\x125.viam.app.datapipelines.v1.DisableDataPipelineRequest\x1a6.viam.app.datapipelines.v1.DisableDataPipelineResponse\x12\x87\x01\n\x14ListDataPipelineRuns\x126.viam.app.datapipelines.v1.ListDataPipelineRunsRequest\x1a7.viam.app.datapipelines.v1.ListDataPipelineRunsResponseB&Z$go.viam.com/api/app/datapipelines/v1b\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n)app/datapipelines/v1/data_pipelines.proto\x12\x19viam.app.datapipelines.v1\x1a\x16app/data/v1/data.proto\x1a\x1fgoogle/protobuf/timestamp.proto"\x93\x03\n\x0cDataPipeline\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id\x12\'\n\x0forganization_id\x18\x02 \x01(\tR\x0eorganizationId\x12\x12\n\x04name\x18\x03 \x01(\tR\x04name\x12\x1d\n\nmql_binary\x18\x04 \x03(\x0cR\tmqlBinary\x12\x1a\n\x08schedule\x18\x05 \x01(\tR\x08schedule\x12\x18\n\x07enabled\x18\x06 \x01(\x08R\x07enabled\x129\n\ncreated_on\x18\x07 \x01(\x0b2\x1a.google.protobuf.TimestampR\tcreatedOn\x129\n\nupdated_at\x18\x08 \x01(\x0b2\x1a.google.protobuf.TimestampR\tupdatedAt\x12V\n\x10data_source_type\x18\t \x01(\x0e2\'.viam.app.data.v1.TabularDataSourceTypeH\x00R\x0edataSourceType\x88\x01\x01B\x13\n\x11_data_source_type"(\n\x16GetDataPipelineRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"g\n\x17GetDataPipelineResponse\x12L\n\rdata_pipeline\x18\x01 \x01(\x0b2\'.viam.app.datapipelines.v1.DataPipelineR\x0cdataPipeline"C\n\x18ListDataPipelinesRequest\x12\'\n\x0forganization_id\x18\x01 \x01(\tR\x0eorganizationId"k\n\x19ListDataPipelinesResponse\x12N\n\x0edata_pipelines\x18\x01 \x03(\x0b2\'.viam.app.datapipelines.v1.DataPipelineR\rdataPipelines"\xc2\x02\n\x19CreateDataPipelineRequest\x12\'\n\x0forganization_id\x18\x01 \x01(\tR\x0eorganizationId\x12\x12\n\x04name\x18\x02 \x01(\tR\x04name\x12\x1d\n\nmql_binary\x18\x03 \x03(\x0cR\tmqlBinary\x12\x1a\n\x08schedule\x18\x04 \x01(\tR\x08schedule\x12,\n\x0fenable_backfill\x18\x05 \x01(\x08H\x00R\x0eenableBackfill\x88\x01\x01\x12V\n\x10data_source_type\x18\x06 \x01(\x0e2\'.viam.app.data.v1.TabularDataSourceTypeH\x01R\x0edataSourceType\x88\x01\x01B\x12\n\x10_enable_backfillB\x13\n\x11_data_source_type",\n\x1aCreateDataPipelineResponse\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"\xe7\x01\n\x19UpdateDataPipelineRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id\x12\x12\n\x04name\x18\x02 \x01(\tR\x04name\x12\x1d\n\nmql_binary\x18\x03 \x03(\x0cR\tmqlBinary\x12\x1a\n\x08schedule\x18\x04 \x01(\tR\x08schedule\x12V\n\x10data_source_type\x18\x05 \x01(\x0e2\'.viam.app.data.v1.TabularDataSourceTypeH\x00R\x0edataSourceType\x88\x01\x01B\x13\n\x11_data_source_type"\x1c\n\x1aUpdateDataPipelineResponse"+\n\x19DeleteDataPipelineRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"\x1c\n\x1aDeleteDataPipelineResponse"+\n\x19EnableDataPipelineRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"\x1c\n\x1aEnableDataPipelineResponse",\n\x1aDisableDataPipelineRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"\x1d\n\x1bDisableDataPipelineResponse"i\n\x1bListDataPipelineRunsRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id\x12\x1b\n\tpage_size\x18\x02 \x01(\rR\x08pageSize\x12\x1d\n\npage_token\x18\x03 \x01(\tR\tpageToken"\xa7\x01\n\x1cListDataPipelineRunsResponse\x12\x1f\n\x0bpipeline_id\x18\x01 \x01(\tR\npipelineId\x12>\n\x04runs\x18\x02 \x03(\x0b2*.viam.app.datapipelines.v1.DataPipelineRunR\x04runs\x12&\n\x0fnext_page_token\x18\x03 \x01(\tR\rnextPageToken"\xe1\x02\n\x0fDataPipelineRun\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id\x129\n\nstart_time\x18\x02 \x01(\x0b2\x1a.google.protobuf.TimestampR\tstartTime\x125\n\x08end_time\x18\x03 \x01(\x0b2\x1a.google.protobuf.TimestampR\x07endTime\x12B\n\x0fdata_start_time\x18\x04 \x01(\x0b2\x1a.google.protobuf.TimestampR\rdataStartTime\x12>\n\rdata_end_time\x18\x05 \x01(\x0b2\x1a.google.protobuf.TimestampR\x0bdataEndTime\x12H\n\x06status\x18\x06 \x01(\x0e20.viam.app.datapipelines.v1.DataPipelineRunStatusR\x06status*\xdc\x01\n\x15DataPipelineRunStatus\x12(\n$DATA_PIPELINE_RUN_STATUS_UNSPECIFIED\x10\x00\x12&\n"DATA_PIPELINE_RUN_STATUS_SCHEDULED\x10\x01\x12$\n DATA_PIPELINE_RUN_STATUS_STARTED\x10\x02\x12&\n"DATA_PIPELINE_RUN_STATUS_COMPLETED\x10\x03\x12#\n\x1fDATA_PIPELINE_RUN_STATUS_FAILED\x10\x042\xb1\x08\n\x14DataPipelinesService\x12x\n\x0fGetDataPipeline\x121.viam.app.datapipelines.v1.GetDataPipelineRequest\x1a2.viam.app.datapipelines.v1.GetDataPipelineResponse\x12~\n\x11ListDataPipelines\x123.viam.app.datapipelines.v1.ListDataPipelinesRequest\x1a4.viam.app.datapipelines.v1.ListDataPipelinesResponse\x12\x81\x01\n\x12CreateDataPipeline\x124.viam.app.datapipelines.v1.CreateDataPipelineRequest\x1a5.viam.app.datapipelines.v1.CreateDataPipelineResponse\x12\x81\x01\n\x12UpdateDataPipeline\x124.viam.app.datapipelines.v1.UpdateDataPipelineRequest\x1a5.viam.app.datapipelines.v1.UpdateDataPipelineResponse\x12\x81\x01\n\x12DeleteDataPipeline\x124.viam.app.datapipelines.v1.DeleteDataPipelineRequest\x1a5.viam.app.datapipelines.v1.DeleteDataPipelineResponse\x12\x81\x01\n\x12EnableDataPipeline\x124.viam.app.datapipelines.v1.EnableDataPipelineRequest\x1a5.viam.app.datapipelines.v1.EnableDataPipelineResponse\x12\x84\x01\n\x13DisableDataPipeline\x125.viam.app.datapipelines.v1.DisableDataPipelineRequest\x1a6.viam.app.datapipelines.v1.DisableDataPipelineResponse\x12\x87\x01\n\x14ListDataPipelineRuns\x126.viam.app.datapipelines.v1.ListDataPipelineRunsRequest\x1a7.viam.app.datapipelines.v1.ListDataPipelineRunsResponseB&Z$go.viam.com/api/app/datapipelines/v1b\x06proto3')
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'app.datapipelines.v1.data_pipelines_pb2', _globals)
 if not _descriptor._USE_C_DESCRIPTORS:
     _globals['DESCRIPTOR']._loaded_options = None
     _globals['DESCRIPTOR']._serialized_options = b'Z$go.viam.com/api/app/datapipelines/v1'
-    _globals['_DATAPIPELINERUNSTATUS']._serialized_start = 1938
-    _globals['_DATAPIPELINERUNSTATUS']._serialized_end = 2158
-    _globals['_DATAPIPELINE']._serialized_start = 106
-    _globals['_DATAPIPELINE']._serialized_end = 400
-    _globals['_GETDATAPIPELINEREQUEST']._serialized_start = 402
-    _globals['_GETDATAPIPELINEREQUEST']._serialized_end = 442
-    _globals['_GETDATAPIPELINERESPONSE']._serialized_start = 444
-    _globals['_GETDATAPIPELINERESPONSE']._serialized_end = 547
-    _globals['_LISTDATAPIPELINESREQUEST']._serialized_start = 549
-    _globals['_LISTDATAPIPELINESREQUEST']._serialized_end = 616
-    _globals['_LISTDATAPIPELINESRESPONSE']._serialized_start = 618
-    _globals['_LISTDATAPIPELINESRESPONSE']._serialized_end = 725
-    _globals['_CREATEDATAPIPELINEREQUEST']._serialized_start = 728
-    _globals['_CREATEDATAPIPELINEREQUEST']._serialized_end = 875
-    _globals['_CREATEDATAPIPELINERESPONSE']._serialized_start = 877
-    _globals['_CREATEDATAPIPELINERESPONSE']._serialized_end = 921
-    _globals['_UPDATEDATAPIPELINEREQUEST']._serialized_start = 923
-    _globals['_UPDATEDATAPIPELINEREQUEST']._serialized_end = 1045
-    _globals['_UPDATEDATAPIPELINERESPONSE']._serialized_start = 1047
-    _globals['_UPDATEDATAPIPELINERESPONSE']._serialized_end = 1075
-    _globals['_DELETEDATAPIPELINEREQUEST']._serialized_start = 1077
-    _globals['_DELETEDATAPIPELINEREQUEST']._serialized_end = 1120
-    _globals['_DELETEDATAPIPELINERESPONSE']._serialized_start = 1122
-    _globals['_DELETEDATAPIPELINERESPONSE']._serialized_end = 1150
-    _globals['_ENABLEDATAPIPELINEREQUEST']._serialized_start = 1152
-    _globals['_ENABLEDATAPIPELINEREQUEST']._serialized_end = 1195
-    _globals['_ENABLEDATAPIPELINERESPONSE']._serialized_start = 1197
-    _globals['_ENABLEDATAPIPELINERESPONSE']._serialized_end = 1225
-    _globals['_DISABLEDATAPIPELINEREQUEST']._serialized_start = 1227
-    _globals['_DISABLEDATAPIPELINEREQUEST']._serialized_end = 1271
-    _globals['_DISABLEDATAPIPELINERESPONSE']._serialized_start = 1273
-    _globals['_DISABLEDATAPIPELINERESPONSE']._serialized_end = 1302
-    _globals['_LISTDATAPIPELINERUNSREQUEST']._serialized_start = 1304
-    _globals['_LISTDATAPIPELINERUNSREQUEST']._serialized_end = 1409
-    _globals['_LISTDATAPIPELINERUNSRESPONSE']._serialized_start = 1412
-    _globals['_LISTDATAPIPELINERUNSRESPONSE']._serialized_end = 1579
-    _globals['_DATAPIPELINERUN']._serialized_start = 1582
-    _globals['_DATAPIPELINERUN']._serialized_end = 1935
-    _globals['_DATAPIPELINESSERVICE']._serialized_start = 2161
-    _globals['_DATAPIPELINESSERVICE']._serialized_end = 3234
+    _globals['_DATAPIPELINERUNSTATUS']._serialized_start = 2356
+    _globals['_DATAPIPELINERUNSTATUS']._serialized_end = 2576
+    _globals['_DATAPIPELINE']._serialized_start = 130
+    _globals['_DATAPIPELINE']._serialized_end = 533
+    _globals['_GETDATAPIPELINEREQUEST']._serialized_start = 535
+    _globals['_GETDATAPIPELINEREQUEST']._serialized_end = 575
+    _globals['_GETDATAPIPELINERESPONSE']._serialized_start = 577
+    _globals['_GETDATAPIPELINERESPONSE']._serialized_end = 680
+    _globals['_LISTDATAPIPELINESREQUEST']._serialized_start = 682
+    _globals['_LISTDATAPIPELINESREQUEST']._serialized_end = 749
+    _globals['_LISTDATAPIPELINESRESPONSE']._serialized_start = 751
+    _globals['_LISTDATAPIPELINESRESPONSE']._serialized_end = 858
+    _globals['_CREATEDATAPIPELINEREQUEST']._serialized_start = 861
+    _globals['_CREATEDATAPIPELINEREQUEST']._serialized_end = 1183
+    _globals['_CREATEDATAPIPELINERESPONSE']._serialized_start = 1185
+    _globals['_CREATEDATAPIPELINERESPONSE']._serialized_end = 1229
+    _globals['_UPDATEDATAPIPELINEREQUEST']._serialized_start = 1232
+    _globals['_UPDATEDATAPIPELINEREQUEST']._serialized_end = 1463
+    _globals['_UPDATEDATAPIPELINERESPONSE']._serialized_start = 1465
+    _globals['_UPDATEDATAPIPELINERESPONSE']._serialized_end = 1493
+    _globals['_DELETEDATAPIPELINEREQUEST']._serialized_start = 1495
+    _globals['_DELETEDATAPIPELINEREQUEST']._serialized_end = 1538
+    _globals['_DELETEDATAPIPELINERESPONSE']._serialized_start = 1540
+    _globals['_DELETEDATAPIPELINERESPONSE']._serialized_end = 1568
+    _globals['_ENABLEDATAPIPELINEREQUEST']._serialized_start = 1570
+    _globals['_ENABLEDATAPIPELINEREQUEST']._serialized_end = 1613
+    _globals['_ENABLEDATAPIPELINERESPONSE']._serialized_start = 1615
+    _globals['_ENABLEDATAPIPELINERESPONSE']._serialized_end = 1643
+    _globals['_DISABLEDATAPIPELINEREQUEST']._serialized_start = 1645
+    _globals['_DISABLEDATAPIPELINEREQUEST']._serialized_end = 1689
+    _globals['_DISABLEDATAPIPELINERESPONSE']._serialized_start = 1691
+    _globals['_DISABLEDATAPIPELINERESPONSE']._serialized_end = 1720
+    _globals['_LISTDATAPIPELINERUNSREQUEST']._serialized_start = 1722
+    _globals['_LISTDATAPIPELINERUNSREQUEST']._serialized_end = 1827
+    _globals['_LISTDATAPIPELINERUNSRESPONSE']._serialized_start = 1830
+    _globals['_LISTDATAPIPELINERUNSRESPONSE']._serialized_end = 1997
+    _globals['_DATAPIPELINERUN']._serialized_start = 2000
+    _globals['_DATAPIPELINERUN']._serialized_end = 2353
+    _globals['_DATAPIPELINESSERVICE']._serialized_start = 2579
+    _globals['_DATAPIPELINESSERVICE']._serialized_end = 3652

viam/gen/app/datapipelines/v1/data_pipelines_pb2.pyi

@@ -2,6 +2,7 @@
 @generated by mypy-protobuf.  Do not edit manually!
 isort:skip_file
 """
+from .... import app
 import builtins
 import collections.abc
 import google.protobuf.descriptor
@@ -49,6 +50,7 @@ class DataPipeline(google.protobuf.message.Message):
     ENABLED_FIELD_NUMBER: builtins.int
     CREATED_ON_FIELD_NUMBER: builtins.int
     UPDATED_AT_FIELD_NUMBER: builtins.int
+    DATA_SOURCE_TYPE_FIELD_NUMBER: builtins.int
     id: builtins.str
     organization_id: builtins.str
     'The associated Viam organization ID.'
@@ -58,6 +60,8 @@ class DataPipeline(google.protobuf.message.Message):
     'A cron expression representing the expected execution schedule in UTC (note this also\n    defines the input time window; an hourly schedule would process 1 hour of data at a time).\n    '
     enabled: builtins.bool
     'Whether or not the pipeline is enabled.'
+    data_source_type: app.data.v1.data_pb2.TabularDataSourceType.ValueType
+    'The type of data source for the pipeline. If not specified, default is standard data storage.'
 
     @property
     def mql_binary(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.bytes]:
@@ -73,13 +77,16 @@ class DataPipeline(google.protobuf.message.Message):
     def updated_at(self) -> google.protobuf.timestamp_pb2.Timestamp:
         """The time the pipeline was last updated."""
 
-    def __init__(self, *, id: builtins.str=..., organization_id: builtins.str=..., name: builtins.str=..., mql_binary: collections.abc.Iterable[builtins.bytes] | None=..., schedule: builtins.str=..., enabled: builtins.bool=..., created_on: google.protobuf.timestamp_pb2.Timestamp | None=..., updated_at: google.protobuf.timestamp_pb2.Timestamp | None=...) -> None:
+    def __init__(self, *, id: builtins.str=..., organization_id: builtins.str=..., name: builtins.str=..., mql_binary: collections.abc.Iterable[builtins.bytes] | None=..., schedule: builtins.str=..., enabled: builtins.bool=..., created_on: google.protobuf.timestamp_pb2.Timestamp | None=..., updated_at: google.protobuf.timestamp_pb2.Timestamp | None=..., data_source_type: app.data.v1.data_pb2.TabularDataSourceType.ValueType | None=...) -> None:
         ...
 
-    def HasField(self, field_name: typing.Literal['created_on', b'created_on', 'updated_at', b'updated_at']) -> builtins.bool:
+    def HasField(self, field_name: typing.Literal['_data_source_type', b'_data_source_type', 'created_on', b'created_on', 'data_source_type', b'data_source_type', 'updated_at', b'updated_at']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['created_on', b'created_on', 'enabled', b'enabled', 'id', b'id', 'mql_binary', b'mql_binary', 'name', b'name', 'organization_id', b'organization_id', 'schedule', b'schedule', 'updated_at', b'updated_at']) -> None:
+    def ClearField(self, field_name: typing.Literal['_data_source_type', b'_data_source_type', 'created_on', b'created_on', 'data_source_type', b'data_source_type', 'enabled', b'enabled', 'id', b'id', 'mql_binary', b'mql_binary', 'name', b'name', 'organization_id', b'organization_id', 'schedule', b'schedule', 'updated_at', b'updated_at']) -> None:
+        ...
+
+    def WhichOneof(self, oneof_group: typing.Literal['_data_source_type', b'_data_source_type']) -> typing.Literal['data_source_type'] | None:
         ...
 global___DataPipeline = DataPipeline
 
@@ -153,12 +160,18 @@ class CreateDataPipelineRequest(google.protobuf.message.Message):
     NAME_FIELD_NUMBER: builtins.int
     MQL_BINARY_FIELD_NUMBER: builtins.int
     SCHEDULE_FIELD_NUMBER: builtins.int
+    ENABLE_BACKFILL_FIELD_NUMBER: builtins.int
+    DATA_SOURCE_TYPE_FIELD_NUMBER: builtins.int
     organization_id: builtins.str
     'The associated Viam organization ID.'
     name: builtins.str
     'A unique identifier at the org level.'
     schedule: builtins.str
     'A cron expression representing the expected execution schedule in UTC (note this also\n    defines the input time window; an hourly schedule would process 1 hour of data at a time).\n    '
+    enable_backfill: builtins.bool
+    "When true, pipeline runs will be scheduled for the organization's past data."
+    data_source_type: app.data.v1.data_pb2.TabularDataSourceType.ValueType
+    'The type of data source for the pipeline. If not specified, default is standard data storage.'
 
     @property
     def mql_binary(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.bytes]:
@@ -166,10 +179,21 @@ class CreateDataPipelineRequest(google.protobuf.message.Message):
         each document is one stage in the pipeline.
         """
 
-    def __init__(self, *, organization_id: builtins.str=..., name: builtins.str=..., mql_binary: collections.abc.Iterable[builtins.bytes] | None=..., schedule: builtins.str=...) -> None:
+    def __init__(self, *, organization_id: builtins.str=..., name: builtins.str=..., mql_binary: collections.abc.Iterable[builtins.bytes] | None=..., schedule: builtins.str=..., enable_backfill: builtins.bool | None=..., data_source_type: app.data.v1.data_pb2.TabularDataSourceType.ValueType | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['_data_source_type', b'_data_source_type', '_enable_backfill', b'_enable_backfill', 'data_source_type', b'data_source_type', 'enable_backfill', b'enable_backfill']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['_data_source_type', b'_data_source_type', '_enable_backfill', b'_enable_backfill', 'data_source_type', b'data_source_type', 'enable_backfill', b'enable_backfill', 'mql_binary', b'mql_binary', 'name', b'name', 'organization_id', b'organization_id', 'schedule', b'schedule']) -> None:
         ...
 
-    def ClearField(self, field_name: typing.Literal['mql_binary', b'mql_binary', 'name', b'name', 'organization_id', b'organization_id', 'schedule', b'schedule']) -> None:
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal['_data_source_type', b'_data_source_type']) -> typing.Literal['data_source_type'] | None:
+        ...
+
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal['_enable_backfill', b'_enable_backfill']) -> typing.Literal['enable_backfill'] | None:
         ...
 global___CreateDataPipelineRequest = CreateDataPipelineRequest
 
@@ -194,12 +218,15 @@ class UpdateDataPipelineRequest(google.protobuf.message.Message):
     NAME_FIELD_NUMBER: builtins.int
     MQL_BINARY_FIELD_NUMBER: builtins.int
     SCHEDULE_FIELD_NUMBER: builtins.int
+    DATA_SOURCE_TYPE_FIELD_NUMBER: builtins.int
     id: builtins.str
     'The ID of the data pipeline to update.'
     name: builtins.str
     'A unique identifier at the org level.'
     schedule: builtins.str
     'A cron expression representing the expected execution schedule in UTC (note this also\n    defines the input time window; an hourly schedule would process 1 hour of data at a time).\n    '
+    data_source_type: app.data.v1.data_pb2.TabularDataSourceType.ValueType
+    'The type of data source for the pipeline. If not specified, default is standard data storage.'
 
     @property
     def mql_binary(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.bytes]:
@@ -207,10 +234,16 @@ class UpdateDataPipelineRequest(google.protobuf.message.Message):
         each document is one stage in the pipeline.
         """
 
-    def __init__(self, *, id: builtins.str=..., name: builtins.str=..., mql_binary: collections.abc.Iterable[builtins.bytes] | None=..., schedule: builtins.str=...) -> None:
+    def __init__(self, *, id: builtins.str=..., name: builtins.str=..., mql_binary: collections.abc.Iterable[builtins.bytes] | None=..., schedule: builtins.str=..., data_source_type: app.data.v1.data_pb2.TabularDataSourceType.ValueType | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['_data_source_type', b'_data_source_type', 'data_source_type', b'data_source_type']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['_data_source_type', b'_data_source_type', 'data_source_type', b'data_source_type', 'id', b'id', 'mql_binary', b'mql_binary', 'name', b'name', 'schedule', b'schedule']) -> None:
         ...
 
-    def ClearField(self, field_name: typing.Literal['id', b'id', 'mql_binary', b'mql_binary', 'name', b'name', 'schedule', b'schedule']) -> None:
+    def WhichOneof(self, oneof_group: typing.Literal['_data_source_type', b'_data_source_type']) -> typing.Literal['data_source_type'] | None:
         ...
 global___UpdateDataPipelineRequest = UpdateDataPipelineRequest