viam.proto.app.datapipelines ============================ .. py:module:: viam.proto.app.datapipelines .. autoapi-nested-parse:: @generated by Viam. Do not edit manually! Classes ------- .. autoapisummary:: viam.proto.app.datapipelines.DataPipelinesServiceBase viam.proto.app.datapipelines.DataPipelinesServiceStub viam.proto.app.datapipelines.UnimplementedDataPipelinesServiceBase viam.proto.app.datapipelines.CreateDataPipelineRequest viam.proto.app.datapipelines.CreateDataPipelineResponse viam.proto.app.datapipelines.DataPipeline viam.proto.app.datapipelines.DataPipelineRun viam.proto.app.datapipelines.DataPipelineRunStatus viam.proto.app.datapipelines.DeleteDataPipelineRequest viam.proto.app.datapipelines.DeleteDataPipelineResponse viam.proto.app.datapipelines.DisableDataPipelineRequest viam.proto.app.datapipelines.DisableDataPipelineResponse viam.proto.app.datapipelines.EnableDataPipelineRequest viam.proto.app.datapipelines.EnableDataPipelineResponse viam.proto.app.datapipelines.GetDataPipelineRequest viam.proto.app.datapipelines.GetDataPipelineResponse viam.proto.app.datapipelines.ListDataPipelineRunsRequest viam.proto.app.datapipelines.ListDataPipelineRunsResponse viam.proto.app.datapipelines.ListDataPipelinesRequest viam.proto.app.datapipelines.ListDataPipelinesResponse viam.proto.app.datapipelines.UpdateDataPipelineRequest viam.proto.app.datapipelines.UpdateDataPipelineResponse Package Contents ---------------- .. py:class:: DataPipelinesServiceBase Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. .. py:method:: GetDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.GetDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.GetDataPipelineResponse]) -> None :abstractmethod: :async: .. py:method:: ListDataPipelines(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.ListDataPipelinesRequest, app.datapipelines.v1.data_pipelines_pb2.ListDataPipelinesResponse]) -> None :abstractmethod: :async: .. py:method:: CreateDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.CreateDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.CreateDataPipelineResponse]) -> None :abstractmethod: :async: .. py:method:: UpdateDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.UpdateDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.UpdateDataPipelineResponse]) -> None :abstractmethod: :async: .. py:method:: DeleteDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.DeleteDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.DeleteDataPipelineResponse]) -> None :abstractmethod: :async: .. py:method:: EnableDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.EnableDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.EnableDataPipelineResponse]) -> None :abstractmethod: :async: .. py:method:: DisableDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.DisableDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.DisableDataPipelineResponse]) -> None :abstractmethod: :async: .. py:method:: ListDataPipelineRuns(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.ListDataPipelineRunsRequest, app.datapipelines.v1.data_pipelines_pb2.ListDataPipelineRunsResponse]) -> None :abstractmethod: :async: .. py:method:: __mapping__() -> Dict[str, grpclib.const.Handler] .. py:class:: DataPipelinesServiceStub(channel: grpclib.client.Channel) .. py:attribute:: GetDataPipeline .. py:attribute:: ListDataPipelines .. py:attribute:: CreateDataPipeline .. py:attribute:: UpdateDataPipeline .. py:attribute:: DeleteDataPipeline .. py:attribute:: EnableDataPipeline .. py:attribute:: DisableDataPipeline .. py:attribute:: ListDataPipelineRuns .. py:class:: UnimplementedDataPipelinesServiceBase Bases: :py:obj:`DataPipelinesServiceBase` Helper class that provides a standard way to create an ABC using inheritance. .. py:method:: GetDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.GetDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.GetDataPipelineResponse]) -> None :async: .. py:method:: ListDataPipelines(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.ListDataPipelinesRequest, app.datapipelines.v1.data_pipelines_pb2.ListDataPipelinesResponse]) -> None :async: .. py:method:: CreateDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.CreateDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.CreateDataPipelineResponse]) -> None :async: .. py:method:: UpdateDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.UpdateDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.UpdateDataPipelineResponse]) -> None :async: .. py:method:: DeleteDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.DeleteDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.DeleteDataPipelineResponse]) -> None :async: .. py:method:: EnableDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.EnableDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.EnableDataPipelineResponse]) -> None :async: .. py:method:: DisableDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.DisableDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.DisableDataPipelineResponse]) -> None :async: .. py:method:: ListDataPipelineRuns(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.ListDataPipelineRunsRequest, app.datapipelines.v1.data_pipelines_pb2.ListDataPipelineRunsResponse]) -> None :async: .. py:class:: CreateDataPipelineRequest(*, organization_id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ..., schedule: str = ..., enable_backfill: bool | None = ..., data_source_type: viam.gen.app.data.v1.data_pb2.TabularDataSourceType.ValueType | None = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: organization_id :type: str The associated Viam organization ID. .. py:attribute:: name :type: str A unique identifier at the org level. .. py:attribute:: schedule :type: 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). .. py:attribute:: enable_backfill :type: bool When true, pipeline runs will be scheduled for the organization's past data. .. py:attribute:: data_source_type :type: viam.gen.app.data.v1.data_pb2.TabularDataSourceType.ValueType The type of data source for the pipeline. If not specified, default is standard data storage. .. py:property:: mql_binary :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes] A MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline. .. py:method:: HasField(field_name: 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']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: WhichOneof(oneof_group: Literal['_data_source_type', b'_data_source_type']) -> Literal['data_source_type'] | None WhichOneof(oneof_group: Literal['_enable_backfill', b'_enable_backfill']) -> Literal['enable_backfill'] | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:class:: CreateDataPipelineResponse(*, id: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: id :type: str The ID of the newly created data pipeline. .. py:class:: DataPipeline(*, id: str = ..., organization_id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ..., schedule: str = ..., enabled: bool = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., updated_at: google.protobuf.timestamp_pb2.Timestamp | None = ..., data_source_type: viam.gen.app.data.v1.data_pb2.TabularDataSourceType.ValueType | None = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: id :type: str .. py:attribute:: organization_id :type: str The associated Viam organization ID. .. py:attribute:: name :type: str A unique identifier at the org level. .. py:attribute:: schedule :type: 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). .. py:attribute:: enabled :type: bool Whether or not the pipeline is enabled. .. py:attribute:: data_source_type :type: viam.gen.app.data.v1.data_pb2.TabularDataSourceType.ValueType The type of data source for the pipeline. If not specified, default is standard data storage. .. py:property:: mql_binary :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes] A MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline. .. py:property:: created_on :type: google.protobuf.timestamp_pb2.Timestamp The time the pipeline was created. .. py:property:: updated_at :type: google.protobuf.timestamp_pb2.Timestamp The time the pipeline was last updated. .. py:method:: HasField(field_name: 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']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: WhichOneof(oneof_group: Literal['_data_source_type', b'_data_source_type']) -> Literal['data_source_type'] | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:class:: DataPipelineRun(*, id: str = ..., start_time: google.protobuf.timestamp_pb2.Timestamp | None = ..., end_time: google.protobuf.timestamp_pb2.Timestamp | None = ..., data_start_time: google.protobuf.timestamp_pb2.Timestamp | None = ..., data_end_time: google.protobuf.timestamp_pb2.Timestamp | None = ..., status: global___DataPipelineRunStatus = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: id :type: str The ID of the run. .. py:attribute:: status :type: global___DataPipelineRunStatus The status of the run. .. py:property:: start_time :type: google.protobuf.timestamp_pb2.Timestamp The time the run started. .. py:property:: end_time :type: google.protobuf.timestamp_pb2.Timestamp The time the run ended. .. py:property:: data_start_time :type: google.protobuf.timestamp_pb2.Timestamp The start time of the data that was processed in the run. .. py:property:: data_end_time :type: google.protobuf.timestamp_pb2.Timestamp The end time of the data that was processed in the run. .. py:method:: HasField(field_name: Literal['data_end_time', b'data_end_time', 'data_start_time', b'data_start_time', 'end_time', b'end_time', 'start_time', b'start_time']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:class:: DataPipelineRunStatus Bases: :py:obj:`_DataPipelineRunStatus` .. py:class:: DeleteDataPipelineRequest(*, id: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: id :type: str The ID of the data pipeline to delete. .. py:class:: DeleteDataPipelineResponse Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:class:: DisableDataPipelineRequest(*, id: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: id :type: str The ID of the data pipeline to disable. .. py:class:: DisableDataPipelineResponse Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:class:: EnableDataPipelineRequest(*, id: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: id :type: str The ID of the data pipeline to enable. .. py:class:: EnableDataPipelineResponse Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:class:: GetDataPipelineRequest(*, id: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: id :type: str The ID of the data pipeline to retrieve. .. py:class:: GetDataPipelineResponse(*, data_pipeline: global___DataPipeline | None = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:property:: data_pipeline :type: global___DataPipeline .. py:method:: HasField(field_name: Literal['data_pipeline', b'data_pipeline']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:class:: ListDataPipelineRunsRequest(*, id: str = ..., page_size: int = ..., page_token: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: id :type: str The ID of the data pipeline to list runs for. .. py:attribute:: page_size :type: int pagination fields .. py:attribute:: page_token :type: str .. py:class:: ListDataPipelineRunsResponse(*, pipeline_id: str = ..., runs: collections.abc.Iterable[global___DataPipelineRun] | None = ..., next_page_token: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: pipeline_id :type: str The ID of the data pipeline the runs are for. .. py:attribute:: next_page_token :type: str A token to retrieve the next page of results. .. py:property:: runs :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___DataPipelineRun] The runs that were run. .. py:class:: ListDataPipelinesRequest(*, organization_id: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: organization_id :type: str The associated Viam organization ID. .. py:class:: ListDataPipelinesResponse(*, data_pipelines: collections.abc.Iterable[global___DataPipeline] | None = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:property:: data_pipelines :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___DataPipeline] .. py:class:: UpdateDataPipelineRequest(*, id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ..., schedule: str = ..., data_source_type: viam.gen.app.data.v1.data_pb2.TabularDataSourceType.ValueType | None = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: id :type: str The ID of the data pipeline to update. .. py:attribute:: name :type: str A unique identifier at the org level. .. py:attribute:: schedule :type: 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). .. py:attribute:: data_source_type :type: viam.gen.app.data.v1.data_pb2.TabularDataSourceType.ValueType The type of data source for the pipeline. If not specified, default is standard data storage. .. py:property:: mql_binary :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes] A MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline. .. py:method:: HasField(field_name: Literal['_data_source_type', b'_data_source_type', 'data_source_type', b'data_source_type']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: WhichOneof(oneof_group: Literal['_data_source_type', b'_data_source_type']) -> Literal['data_source_type'] | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:class:: UpdateDataPipelineResponse Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.